diff --git a/src/apis/acceleratedmobilepageurl/README.md b/src/apis/acceleratedmobilepageurl/README.md index 38a8f27343..3c13783d61 100644 --- a/src/apis/acceleratedmobilepageurl/README.md +++ b/src/apis/acceleratedmobilepageurl/README.md @@ -2,7 +2,7 @@ # acceleratedmobilepageurl -> This API contains a single method, batchGet. Call this method to retrieve the AMP URL (and equivalent AMP Cache URL) for given public URL(s). +> Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s). ## Installation diff --git a/src/apis/accessapproval/index.ts b/src/apis/accessapproval/index.ts index b6071a2b00..d1ec5f3b39 100644 --- a/src/apis/accessapproval/index.ts +++ b/src/apis/accessapproval/index.ts @@ -14,21 +14,33 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {accessapproval_v1} from './v1'; import {accessapproval_v1beta1} from './v1beta1'; export const VERSIONS = { + v1: accessapproval_v1.Accessapproval, v1beta1: accessapproval_v1beta1.Accessapproval, }; +export function accessapproval(version: 'v1'): accessapproval_v1.Accessapproval; +export function accessapproval( + options: accessapproval_v1.Options +): accessapproval_v1.Accessapproval; export function accessapproval( version: 'v1beta1' ): accessapproval_v1beta1.Accessapproval; export function accessapproval( options: accessapproval_v1beta1.Options ): accessapproval_v1beta1.Accessapproval; -export function accessapproval( +export function accessapproval< + T = accessapproval_v1.Accessapproval | accessapproval_v1beta1.Accessapproval +>( this: GoogleConfigurable, - versionOrOptions: 'v1beta1' | accessapproval_v1beta1.Options + versionOrOptions: + | 'v1' + | accessapproval_v1.Options + | 'v1beta1' + | accessapproval_v1beta1.Options ) { return getAPI('accessapproval', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/accessapproval/v1.ts b/src/apis/accessapproval/v1.ts new file mode 100644 index 0000000000..32ccd1be74 --- /dev/null +++ b/src/apis/accessapproval/v1.ts @@ -0,0 +1,2297 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace accessapproval_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; + } + + /** + * Access Approval API + * + * An API for controlling access to data by Google personnel. + * + * @example + * const {google} = require('googleapis'); + * const accessapproval = google.accessapproval('v1'); + * + * @namespace accessapproval + * @type {Function} + * @version v1 + * @variation v1 + * @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 { + /** + * Output only. This field is read only (not settable via UpdateAccessAccessApprovalSettings method). If the field is true, that indicates that at least one service is enrolled for Access Approval in one or more ancestors of the Project or Folder (this field will always be unset for the organization since organizations do not have ancestors). + */ + enrolledAncestor?: boolean | null; + /** + * A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. + */ + enrolledServices?: Schema$EnrolledService[]; + /** + * 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 | null; + /** + * 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. A maximum of 50 email addresses are allowed. + */ + notificationEmails?: string[] | null; + } + /** + * 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 | null; + /** + * 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 | null; + } + export interface Schema$AccessReason { + /** + * More detail about certain reason types. See comments for each type above. + */ + detail?: string | null; + /** + * Type of access justification. + */ + type?: string | null; + } + /** + * 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 | null; + /** + * 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 | null; + /** + * 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 | null; + /** + * Properties related to the resource represented by requested_resource_name. + */ + requestedResourceProperties?: Schema$ResourceProperties; + /** + * The time at which approval was requested. + */ + requestTime?: string | null; + } + /** + * Request to approve an ApprovalRequest. + */ + export interface Schema$ApproveApprovalRequestMessage { + /** + * The expiration time of this approval. + */ + expireTime?: string | null; + } + /** + * 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 | null; + /** + * The time at which the approval expires. + */ + expireTime?: string | null; + } + /** + * 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 | null; + } + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Represents the enrollment of a cloud resource into a specific service. + */ + export interface Schema$EnrolledService { + /** + * The product for which Access Approval will be enrolled. Allowed values are listed below (case-sensitive): <ol> <li>all</li> <li>appengine.googleapis.com</li> <li>bigquery.googleapis.com</li> <li>bigtable.googleapis.com</li> <li>cloudkms.googleapis.com</li> <li>compute.googleapis.com</li> <li>dataflow.googleapis.com</li> <li>iam.googleapis.com</li> <li>pubsub.googleapis.com</li> <li>storage.googleapis.com</li> <ol> + */ + cloudProduct?: string | null; + /** + * The enrollment level of the service. + */ + enrollmentLevel?: string | null; + } + /** + * 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 | null; + } + /** + * The properties associated with the resource of the request. + */ + export interface Schema$ResourceProperties { + /** + * Whether an approval will exclude the descendants of the resource being requested. + */ + excludesDescendants?: boolean | null; + } + + 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.deleteAccessApprovalSettings + * @desc Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. + * @alias accessapproval.folders.deleteAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the AccessApprovalSettings 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 + */ + deleteAccessApprovalSettings( + params?: Params$Resource$Folders$Deleteaccessapprovalsettings, + options?: MethodOptions + ): GaxiosPromise; + deleteAccessApprovalSettings( + params: Params$Resource$Folders$Deleteaccessapprovalsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + params: Params$Resource$Folders$Deleteaccessapprovalsettings, + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + paramsOrCallback?: + | Params$Resource$Folders$Deleteaccessapprovalsettings + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Deleteaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Deleteaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + /** + * 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 + '/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); + } + } + + /** + * accessapproval.folders.updateAccessApprovalSettings + * @desc Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. + * @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"
    1. + * @param {string=} params.updateMask The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. + * @param {().AccessApprovalSettings} params.requestBody Request 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 + '/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); + } + } + } + + export interface Params$Resource$Folders$Deleteaccessapprovalsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the AccessApprovalSettings to delete. + */ + name?: string; + } + 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. "folders/{folder_id}/accessApprovalSettings"
      3. "organizations/{organization_id}/accessApprovalSettings"
        1. + */ + name?: string; + /** + * The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. + */ + updateMask?: 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.requestBody Request 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 + '/v1/{+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.requestBody Request 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 + '/v1/{+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 + '/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); + } + } + + /** + * 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 + '/v1/{+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.deleteAccessApprovalSettings + * @desc Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. + * @alias accessapproval.organizations.deleteAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the AccessApprovalSettings 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 + */ + deleteAccessApprovalSettings( + params?: Params$Resource$Organizations$Deleteaccessapprovalsettings, + options?: MethodOptions + ): GaxiosPromise; + deleteAccessApprovalSettings( + params: Params$Resource$Organizations$Deleteaccessapprovalsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + params: Params$Resource$Organizations$Deleteaccessapprovalsettings, + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + paramsOrCallback?: + | Params$Resource$Organizations$Deleteaccessapprovalsettings + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Deleteaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Deleteaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + /** + * 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 + '/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); + } + } + + /** + * accessapproval.organizations.updateAccessApprovalSettings + * @desc Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. + * @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"
            1. + * @param {string=} params.updateMask The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. + * @param {().AccessApprovalSettings} params.requestBody Request 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 + '/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); + } + } + } + + export interface Params$Resource$Organizations$Deleteaccessapprovalsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the AccessApprovalSettings to delete. + */ + name?: string; + } + 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. "folders/{folder_id}/accessApprovalSettings"
              3. "organizations/{organization_id}/accessApprovalSettings"
                1. + */ + name?: string; + /** + * The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. + */ + updateMask?: 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.requestBody Request 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 + '/v1/{+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.requestBody Request 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 + '/v1/{+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 + '/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); + } + } + + /** + * 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 + '/v1/{+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.deleteAccessApprovalSettings + * @desc Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited. + * @alias accessapproval.projects.deleteAccessApprovalSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Name of the AccessApprovalSettings 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 + */ + deleteAccessApprovalSettings( + params?: Params$Resource$Projects$Deleteaccessapprovalsettings, + options?: MethodOptions + ): GaxiosPromise; + deleteAccessApprovalSettings( + params: Params$Resource$Projects$Deleteaccessapprovalsettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + params: Params$Resource$Projects$Deleteaccessapprovalsettings, + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + callback: BodyResponseCallback + ): void; + deleteAccessApprovalSettings( + paramsOrCallback?: + | Params$Resource$Projects$Deleteaccessapprovalsettings + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Deleteaccessapprovalsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Deleteaccessapprovalsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accessapproval.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); + } + } + + /** + * 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 + '/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); + } + } + + /** + * accessapproval.projects.updateAccessApprovalSettings + * @desc Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask. + * @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"
                    1. + * @param {string=} params.updateMask The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. + * @param {().AccessApprovalSettings} params.requestBody Request 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 + '/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); + } + } + } + + export interface Params$Resource$Projects$Deleteaccessapprovalsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the AccessApprovalSettings to delete. + */ + name?: string; + } + 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. "folders/{folder_id}/accessApprovalSettings"
                      3. "organizations/{organization_id}/accessApprovalSettings"
                        1. + */ + name?: string; + /** + * The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. + */ + updateMask?: 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.requestBody Request 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 + '/v1/{+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.requestBody Request 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 + '/v1/{+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 + '/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); + } + } + + /** + * 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 + '/v1/{+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/accesscontextmanager/v1.ts b/src/apis/accesscontextmanager/v1.ts index 1d3027b516..90e8b37858 100644 --- a/src/apis/accesscontextmanager/v1.ts +++ b/src/apis/accesscontextmanager/v1.ts @@ -118,7 +118,7 @@ export namespace accesscontextmanager_v1 { } /** - * An `AccessLevel` is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied. + * An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied. */ export interface Schema$AccessLevel { /** @@ -129,6 +129,10 @@ export namespace accesscontextmanager_v1 { * Output only. Time the `AccessLevel` was created in UTC. */ createTime?: string | null; + /** + * A `CustomLevel` written in the Common Expression Language. + */ + custom?: Schema$CustomLevel; /** * Description of the `AccessLevel` and its use. Does not affect behavior. */ @@ -147,7 +151,7 @@ export namespace accesscontextmanager_v1 { updateTime?: string | null; } /** - * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. + * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. */ export interface Schema$AccessPolicy { /** @@ -188,6 +192,24 @@ export namespace accesscontextmanager_v1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} + /** + * A request to commit dry-run specs in all Service Perimeters belonging to an Access Policy. + */ + export interface Schema$CommitServicePerimetersRequest { + /** + * Optional. The etag for the version of the Access Policy that this commit operation is to be performed on. If, at the time of commit, the etag for the Access Policy stored in Access Context Manager is different from the specified etag, then the commit operation will not be performed and the call will fail. This field is not required. If etag is not provided, the operation will be performed as if a valid etag is provided. + */ + etag?: string | null; + } + /** + * A response to CommitServicePerimetersRequest. This will be put inside of Operation.response field. + */ + export interface Schema$CommitServicePerimetersResponse { + /** + * List of all the Service Perimeter instances in the Access Policy. + */ + servicePerimeters?: Schema$ServicePerimeter[]; + } /** * A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction. */ @@ -217,6 +239,15 @@ export namespace accesscontextmanager_v1 { */ requiredAccessLevels?: string[] | null; } + /** + * `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec + */ + export interface Schema$CustomLevel { + /** + * Required. A Cloud CEL expression evaluating to a boolean. + */ + expr?: Schema$Expr; + } /** * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. */ @@ -250,6 +281,27 @@ export namespace accesscontextmanager_v1 { * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } /** * A response to `ListAccessLevelsRequest`. */ @@ -345,7 +397,51 @@ export namespace accesscontextmanager_v1 { requireVerifiedChromeOs?: boolean | null; } /** - * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. + * A request to replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. + */ + export interface Schema$ReplaceAccessLevelsRequest { + /** + * Required. The desired Access Levels that should replace all existing Access Levels in the Access Policy. + */ + accessLevels?: Schema$AccessLevel[]; + /** + * Optional. The etag for the version of the Access Policy that this replace operation is to be performed on. If, at the time of replace, the etag for the Access Policy stored in Access Context Manager is different from the specified etag, then the replace operation will not be performed and the call will fail. This field is not required. If etag is not provided, the operation will be performed as if a valid etag is provided. + */ + etag?: string | null; + } + /** + * A response to ReplaceAccessLevelsRequest. This will be put inside of Operation.response field. + */ + export interface Schema$ReplaceAccessLevelsResponse { + /** + * List of the Access Level instances. + */ + accessLevels?: Schema$AccessLevel[]; + } + /** + * A request to replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. + */ + export interface Schema$ReplaceServicePerimetersRequest { + /** + * Optional. The etag for the version of the Access Policy that this replace operation is to be performed on. If, at the time of replace, the etag for the Access Policy stored in Access Context Manager is different from the specified etag, then the replace operation will not be performed and the call will fail. This field is not required. If etag is not provided, the operation will be performed as if a valid etag is provided. + */ + etag?: string | null; + /** + * Required. The desired Service Perimeters that should replace all existing Service Perimeters in the Access Policy. + */ + servicePerimeters?: Schema$ServicePerimeter[]; + } + /** + * A response to ReplaceServicePerimetersRequest. This will be put inside of Operation.response field. + */ + export interface Schema$ReplaceServicePerimetersResponse { + /** + * List of the Service Perimeter instances. + */ + servicePerimeters?: Schema$ServicePerimeter[]; + } + /** + * `ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges. */ export interface Schema$ServicePerimeter { /** @@ -364,6 +460,10 @@ export namespace accesscontextmanager_v1 { * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty. */ perimeterType?: string | null; + /** + * Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the "use_explicit_dry_run_spec" flag is set. + */ + spec?: Schema$ServicePerimeterConfig; /** * Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. */ @@ -376,23 +476,31 @@ export namespace accesscontextmanager_v1 { * Output only. Time the `ServicePerimeter` was updated in UTC. */ updateTime?: string | null; + /** + * Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values. + */ + useExplicitDryRunSpec?: boolean | null; } /** - * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration. + * `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. */ export interface Schema$ServicePerimeterConfig { /** - * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. + * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ accessLevels?: string[] | null; /** - * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` + * A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ resources?: string[] | null; /** - * GCP services that are subject to the Service Perimeter restrictions. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. + * Google Cloud services that are subject to the Service Perimeter restrictions. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. */ restrictedServices?: string[] | null; + /** + * Configuration for APIs allowed within Perimeter. + */ + vpcAccessibleServices?: Schema$VpcAccessibleServices; } /** * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). @@ -411,6 +519,19 @@ export namespace accesscontextmanager_v1 { */ message?: string | null; } + /** + * Specifies how APIs are allowed to communicate within the Service Perimeter. + */ + export interface Schema$VpcAccessibleServices { + /** + * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. + */ + allowedServices?: string[] | null; + /** + * Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + */ + enableRestriction?: boolean | null; + } export class Resource$Accesspolicies { context: APIRequestContext; @@ -1256,6 +1377,82 @@ export namespace accesscontextmanager_v1 { return createAPIRequest(parameters); } } + + /** + * accesscontextmanager.accessPolicies.accessLevels.replaceAll + * @desc Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error. + * @alias accesscontextmanager.accessPolicies.accessLevels.replaceAll + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Resource name for the access policy which owns these Access Levels. Format: `accessPolicies/{policy_id}` + * @param {().ReplaceAccessLevelsRequest} params.requestBody Request 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 + */ + replaceAll( + params?: Params$Resource$Accesspolicies$Accesslevels$Replaceall, + options?: MethodOptions + ): GaxiosPromise; + replaceAll( + params: Params$Resource$Accesspolicies$Accesslevels$Replaceall, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceAll( + params: Params$Resource$Accesspolicies$Accesslevels$Replaceall, + callback: BodyResponseCallback + ): void; + replaceAll(callback: BodyResponseCallback): void; + replaceAll( + paramsOrCallback?: + | Params$Resource$Accesspolicies$Accesslevels$Replaceall + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accesspolicies$Accesslevels$Replaceall; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accesspolicies$Accesslevels$Replaceall; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accesscontextmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/accessLevels:replaceAll').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$Accesspolicies$Accesslevels$Create @@ -1348,6 +1545,23 @@ export namespace accesscontextmanager_v1 { */ requestBody?: Schema$AccessLevel; } + export interface Params$Resource$Accesspolicies$Accesslevels$Replaceall + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Resource name for the access policy which owns these Access Levels. Format: `accessPolicies/{policy_id}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceAccessLevelsRequest; + } export class Resource$Accesspolicies$Serviceperimeters { context: APIRequestContext; @@ -1355,6 +1569,82 @@ export namespace accesscontextmanager_v1 { this.context = context; } + /** + * accesscontextmanager.accessPolicies.servicePerimeters.commit + * @desc Commit the dry-run spec for all the Service Perimeters in an Access Policy. A commit operation on a Service Perimeter involves copying its `spec` field to that Service Perimeter's `status` field. Only Service Perimeters with `use_explicit_dry_run_spec` field set to true are affected by a commit operation. The longrunning operation from this RPC will have a successful status once the dry-run specs for all the Service Perimeters have been committed. If a commit fails, it will cause the longrunning operation to return an error response and the entire commit operation will be cancelled. When successful, Operation.response field will contain CommitServicePerimetersResponse. The `dry_run` and the `spec` fields will be cleared after a successful commit operation. + * @alias accesscontextmanager.accessPolicies.servicePerimeters.commit + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Resource name for the parent Access Policy which owns all Service Perimeters in scope for the commit operation. Format: `accessPolicies/{policy_id}` + * @param {().CommitServicePerimetersRequest} params.requestBody Request 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 + */ + commit( + params?: Params$Resource$Accesspolicies$Serviceperimeters$Commit, + options?: MethodOptions + ): GaxiosPromise; + commit( + params: Params$Resource$Accesspolicies$Serviceperimeters$Commit, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + commit( + params: Params$Resource$Accesspolicies$Serviceperimeters$Commit, + callback: BodyResponseCallback + ): void; + commit(callback: BodyResponseCallback): void; + commit( + paramsOrCallback?: + | Params$Resource$Accesspolicies$Serviceperimeters$Commit + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accesspolicies$Serviceperimeters$Commit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accesspolicies$Serviceperimeters$Commit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accesscontextmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/servicePerimeters:commit').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * accesscontextmanager.accessPolicies.servicePerimeters.create * @desc Create an Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered. @@ -1734,8 +2024,100 @@ export namespace accesscontextmanager_v1 { return createAPIRequest(parameters); } } + + /** + * accesscontextmanager.accessPolicies.servicePerimeters.replaceAll + * @desc Replace all existing Service Perimeters in an Access Policy with the Service Perimeters provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Service Perimeters will not be affected. Operation.response field will contain ReplaceServicePerimetersResponse. + * @alias accesscontextmanager.accessPolicies.servicePerimeters.replaceAll + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Resource name for the access policy which owns these Service Perimeters. Format: `accessPolicies/{policy_id}` + * @param {().ReplaceServicePerimetersRequest} params.requestBody Request 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 + */ + replaceAll( + params?: Params$Resource$Accesspolicies$Serviceperimeters$Replaceall, + options?: MethodOptions + ): GaxiosPromise; + replaceAll( + params: Params$Resource$Accesspolicies$Serviceperimeters$Replaceall, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceAll( + params: Params$Resource$Accesspolicies$Serviceperimeters$Replaceall, + callback: BodyResponseCallback + ): void; + replaceAll(callback: BodyResponseCallback): void; + replaceAll( + paramsOrCallback?: + | Params$Resource$Accesspolicies$Serviceperimeters$Replaceall + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accesspolicies$Serviceperimeters$Replaceall; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accesspolicies$Serviceperimeters$Replaceall; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://accesscontextmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+parent}/servicePerimeters:replaceAll' + ).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$Accesspolicies$Serviceperimeters$Commit + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Resource name for the parent Access Policy which owns all Service Perimeters in scope for the commit operation. Format: `accessPolicies/{policy_id}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CommitServicePerimetersRequest; + } export interface Params$Resource$Accesspolicies$Serviceperimeters$Create extends StandardParameters { /** @@ -1818,6 +2200,23 @@ export namespace accesscontextmanager_v1 { */ requestBody?: Schema$ServicePerimeter; } + export interface Params$Resource$Accesspolicies$Serviceperimeters$Replaceall + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Resource name for the access policy which owns these Service Perimeters. Format: `accessPolicies/{policy_id}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceServicePerimetersRequest; + } export class Resource$Operations { context: APIRequestContext; diff --git a/src/apis/accesscontextmanager/v1beta.ts b/src/apis/accesscontextmanager/v1beta.ts index c35b4f70e5..82fca4f955 100644 --- a/src/apis/accesscontextmanager/v1beta.ts +++ b/src/apis/accesscontextmanager/v1beta.ts @@ -118,7 +118,7 @@ export namespace accesscontextmanager_v1beta { } /** - * An `AccessLevel` is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied. + * An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied. */ export interface Schema$AccessLevel { /** @@ -129,6 +129,10 @@ export namespace accesscontextmanager_v1beta { * Output only. Time the `AccessLevel` was created in UTC. */ createTime?: string | null; + /** + * A `CustomLevel` written in the Common Expression Language. + */ + custom?: Schema$CustomLevel; /** * Description of the `AccessLevel` and its use. Does not affect behavior. */ @@ -147,7 +151,7 @@ export namespace accesscontextmanager_v1beta { updateTime?: string | null; } /** - * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. + * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. */ export interface Schema$AccessPolicy { /** @@ -213,6 +217,15 @@ export namespace accesscontextmanager_v1beta { */ requiredAccessLevels?: string[] | null; } + /** + * `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec + */ + export interface Schema$CustomLevel { + /** + * Required. A Cloud CEL expression evaluating to a boolean. + */ + expr?: Schema$Expr; + } /** * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. */ @@ -242,6 +255,27 @@ export namespace accesscontextmanager_v1beta { */ requireScreenlock?: boolean | null; } + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } /** * A response to `ListAccessLevelsRequest`. */ @@ -324,7 +358,7 @@ export namespace accesscontextmanager_v1beta { requireVerifiedChromeOs?: boolean | null; } /** - * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. + * `ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges. */ export interface Schema$ServicePerimeter { /** @@ -357,27 +391,31 @@ export namespace accesscontextmanager_v1beta { updateTime?: string | null; } /** - * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration. + * `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. */ export interface Schema$ServicePerimeterConfig { /** - * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. + * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ accessLevels?: string[] | null; /** - * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` + * A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ resources?: string[] | null; /** - * GCP services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. + * Google Cloud services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. */ restrictedServices?: string[] | null; /** - * GCP services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted. + * Google Cloud services that are not subject to the Service Perimeter restrictions. Deprecated. Must be set to a single wildcard "*". The wildcard means that unless explicitly specified by "restricted_services" list, any service is treated as unrestricted. */ unrestrictedServices?: string[] | null; /** - * Alpha. Configuration for within Perimeter allowed APIs. + * Beta. Configuration for within Perimeter allowed APIs. + */ + vpcAccessibleServices?: Schema$VpcAccessibleServices; + /** + * Alpha. Configuration for within Perimeter allowed APIs. Deprecated. The field had been renamed to vpc_accessible_services */ vpcServiceRestriction?: Schema$VpcServiceRestriction; } @@ -399,7 +437,20 @@ export namespace accesscontextmanager_v1beta { message?: string | null; } /** - * Alpha. Specifies how APIs are allowed to communicate within the Service Perimeter. + * Specifies how APIs are allowed to communicate within the Service Perimeter. + */ + export interface Schema$VpcAccessibleServices { + /** + * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. + */ + allowedServices?: string[] | null; + /** + * Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + */ + enableRestriction?: boolean | null; + } + /** + * Alpha. Specifies how APIs are allowed to communicate within the Service Perimeter. This message is DEPRECATED and had been renamed to VpcAccessibleServices */ export interface Schema$VpcServiceRestriction { /** diff --git a/src/apis/plusDomains/README.md b/src/apis/admob/README.md similarity index 82% rename from src/apis/plusDomains/README.md rename to src/apis/admob/README.md index 1d9860d08c..0b92d22621 100644 --- a/src/apis/plusDomains/README.md +++ b/src/apis/admob/README.md @@ -1,8 +1,8 @@ Google Inc. logo -# plusDomains +# admob -> Builds on top of the Google+ platform for Google Apps Domains. +> The Google AdMob API lets you programmatically get reports on earnings. ## Installation @@ -19,17 +19,17 @@ This library can be used in a browser. To prepare a single file bundle, clone th [repository](https://github.com/googleapis/google-api-nodejs-client) and run ```sh -$ cd src/apis/plusDomains +$ cd src/apis/admob $ npm install $ npm run webpack ``` -The generated bundle will be written to `dist/plusDomains.min.js`. Use it from your HTML file: +The generated bundle will be written to `dist/admob.min.js`. Use it from your HTML file: ```html - + ``` diff --git a/src/apis/plusDomains/index.ts b/src/apis/admob/index.ts similarity index 65% rename from src/apis/plusDomains/index.ts rename to src/apis/admob/index.ts index 6c7bf9e7c3..3d17f92af9 100644 --- a/src/apis/plusDomains/index.ts +++ b/src/apis/admob/index.ts @@ -14,21 +14,19 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {plusDomains_v1} from './v1'; +import {admob_v1} from './v1'; export const VERSIONS = { - v1: plusDomains_v1.Plusdomains, + v1: admob_v1.Admob, }; -export function plusDomains(version: 'v1'): plusDomains_v1.Plusdomains; -export function plusDomains( - options: plusDomains_v1.Options -): plusDomains_v1.Plusdomains; -export function plusDomains( +export function admob(version: 'v1'): admob_v1.Admob; +export function admob(options: admob_v1.Options): admob_v1.Admob; +export function admob( this: GoogleConfigurable, - versionOrOptions: 'v1' | plusDomains_v1.Options + versionOrOptions: 'v1' | admob_v1.Options ) { - return getAPI('plusDomains', versionOrOptions, VERSIONS, this); + return getAPI('admob', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); diff --git a/src/apis/replicapool/package.json b/src/apis/admob/package.json similarity index 93% rename from src/apis/replicapool/package.json rename to src/apis/admob/package.json index b223300465..186f009ff7 100644 --- a/src/apis/replicapool/package.json +++ b/src/apis/admob/package.json @@ -1,7 +1,7 @@ { - "name": "@google/replicapool", + "name": "@google/admob", "version": "0.1.0", - "description": "replicapool", + "description": "admob", "main": "build/index.js", "types": "build/index.d.ts", "keywords": [ diff --git a/src/apis/gamesConfiguration/tsconfig.json b/src/apis/admob/tsconfig.json similarity index 100% rename from src/apis/gamesConfiguration/tsconfig.json rename to src/apis/admob/tsconfig.json diff --git a/src/apis/admob/v1.ts b/src/apis/admob/v1.ts new file mode 100644 index 0000000000..efd29e8267 --- /dev/null +++ b/src/apis/admob/v1.ts @@ -0,0 +1,884 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace admob_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; + } + + /** + * AdMob API + * + * The Google AdMob API lets you programmatically get reports on earnings. + * + * @example + * const {google} = require('googleapis'); + * const admob = google.admob('v1'); + * + * @namespace admob + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Admob + */ + export class Admob { + context: APIRequestContext; + accounts: Resource$Accounts; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.accounts = new Resource$Accounts(this.context); + } + } + + /** + * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. + */ + export interface Schema$Date { + /** + * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant. + */ + day?: number | null; + /** + * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day. + */ + month?: number | null; + /** + * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year. + */ + year?: number | null; + } + /** + * Specification of a single date range. Both dates are inclusive. + */ + export interface Schema$DateRange { + /** + * End date of the date range, inclusive. Must be greater than or equal to the start date. + */ + endDate?: Schema$Date; + /** + * Start date of the date range, inclusive. Must be less than or equal to the end date. + */ + startDate?: Schema$Date; + } + /** + * Request to generate an AdMob Mediation report. + */ + export interface Schema$GenerateMediationReportRequest { + /** + * Network report specification. + */ + reportSpec?: Schema$MediationReportSpec; + } + /** + * The streaming response for the AdMob Mediation report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: [{ "header": { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 30} } "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } }, { "row": { "dimension_values": { "DATE": {"value": "20180918"}, "APP": { "value": "ca-app-pub-8123415297019784~1001342552", "display_label": "My app name!" } }, "metric_values": { "ESTIMATED_EARNINGS": {"decimal_value": "1324746"} } } }, { "footer": {"matching_row_count": 1} }] + */ + export interface Schema$GenerateMediationReportResponse { + /** + * Additional information about the generated report, such as warnings about the data. + */ + footer?: Schema$ReportFooter; + /** + * Report generation settings that describes the report contents, such as the report date range and localization settings. + */ + header?: Schema$ReportHeader; + /** + * Actual report data. + */ + row?: Schema$ReportRow; + } + /** + * Request to generate an AdMob Network report. + */ + export interface Schema$GenerateNetworkReportRequest { + /** + * Network report specification. + */ + reportSpec?: Schema$NetworkReportSpec; + } + /** + * The streaming response for the AdMob Network report where the first response contains the report header, then a stream of row responses, and finally a footer as the last response message. For example: [{ "header": { "dateRange": { "startDate": {"year": 2018, "month": 9, "day": 1}, "endDate": {"year": 2018, "month": 9, "day": 30} } "localizationSettings": { "currencyCode": "USD", "languageCode": "en-US" } } }, { "row": { "dimensionValues": { "DATE": {"value": "20180918"}, "APP": { "value": "ca-app-pub-8123415297019784~1001342552", displayLabel: "My app name!" } }, "metricValues": { "ESTIMATED_EARNINGS": {"microsValue": 6500000} } } }, ... { "footer": {"matchingRowCount": 5} }] + */ + export interface Schema$GenerateNetworkReportResponse { + /** + * Additional information about the generated report, such as warnings about the data. + */ + footer?: Schema$ReportFooter; + /** + * Report generation settings that describes the report contents, such as the report date range and localization settings. + */ + header?: Schema$ReportHeader; + /** + * Actual report data. + */ + row?: Schema$ReportRow; + } + /** + * Response for the publisher account list request. + */ + export interface Schema$ListPublisherAccountsResponse { + /** + * Publisher that the client credentials can access. + */ + account?: Schema$PublisherAccount[]; + /** + * If not empty, indicates that there might be more accounts for the request; you must pass this value in a new `ListPublisherAccountsRequest`. + */ + nextPageToken?: string | null; + } + /** + * Localization settings for reports, such as currency and language. It affects how metrics are calculated. + */ + export interface Schema$LocalizationSettings { + /** + * Currency code of the earning related metrics, which is the 3-letter code defined in ISO 4217. The daily average rate is used for the currency conversion. Defaults to the account currency code if unspecified. + */ + currencyCode?: string | null; + /** + * Language used for any localized text, such as some dimension value display labels. The language tag defined in the IETF BCP47. Defaults to 'en-US' if unspecified. + */ + languageCode?: string | null; + } + /** + * The specification for generating an AdMob Mediation report. For example, the specification to get observed ECPM sliced by ad source and app for the 'US' and 'CN' countries can look like the following example: { "date_range": { "start_date": {"year": 2018, "month": 9, "day": 1}, "end_date": {"year": 2018, "month": 9, "day": 30} }, "dimensions": ["AD_SOURCE", "APP", "COUNTRY"], "metrics": ["OBSERVED_ECPM"], "dimension_filters": [ { "dimension": "COUNTRY", "matches_any": {"values": [{"value": "US", "value": "CN"}]} } ], "sort_conditions": [ {"dimension":"APP", order: "ASCENDING"} ], "localization_settings": { "currency_code": "USD", "language_code": "en-US" } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT AD_SOURCE, APP, COUNTRY, OBSERVED_ECPM FROM MEDIATION_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY AD_SOURCE, APP, COUNTRY ORDER BY APP ASC; + */ + export interface Schema$MediationReportSpec { + /** + * The date range for which the report is generated. + */ + dateRange?: Schema$DateRange; + /** + * Describes which report rows to match based on their dimension values. + */ + dimensionFilters?: Schema$MediationReportSpecDimensionFilter[]; + /** + * List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account. + */ + dimensions?: string[] | null; + /** + * Localization settings of the report. + */ + localizationSettings?: Schema$LocalizationSettings; + /** + * Maximum number of report data rows to return. If the value is not set, the API returns as many rows as possible, up to 100000. Acceptable values are 1-100000, inclusive. Any other values are treated as 100000. + */ + maxReportRows?: number | null; + /** + * List of metrics of the report. A report must specify at least one metric. + */ + metrics?: string[] | null; + /** + * Describes the sorting of report rows. The order of the condition in the list defines its precedence; the earlier the condition, the higher its precedence. If no sort conditions are specified, the row ordering is undefined. + */ + sortConditions?: Schema$MediationReportSpecSortCondition[]; + /** + * A report time zone. Accepts an IANA TZ name values, such as "America/Los_Angeles." If no time zone is defined, the account default takes effect. Check default value by the get account action. **Warning:** The "America/Los_Angeles" is the only supported value at the moment. + */ + timeZone?: string | null; + } + /** + * Describes which report rows to match based on their dimension values. + */ + export interface Schema$MediationReportSpecDimensionFilter { + /** + * Applies the filter criterion to the specified dimension. + */ + dimension?: string | null; + /** + * Matches a row if its value for the specified dimension is in one of the values specified in this condition. + */ + matchesAny?: Schema$StringList; + } + /** + * Sorting direction to be applied on a dimension or a metric. + */ + export interface Schema$MediationReportSpecSortCondition { + /** + * Sort by the specified dimension. + */ + dimension?: string | null; + /** + * Sort by the specified metric. + */ + metric?: string | null; + /** + * Sorting order of the dimension or metric. + */ + order?: string | null; + } + /** + * The specification for generating an AdMob Network report. For example, the specification to get clicks and estimated earnings for only the 'US' and 'CN' countries can look like the following example: { 'date_range': { 'start_date': {'year': 2018, 'month': 9, 'day': 1}, 'end_date': {'year': 2018, 'month': 9, 'day': 30} }, 'dimensions': ['DATE', 'APP', 'COUNTRY'], 'metrics': ['CLICKS', 'ESTIMATED_EARNINGS'], 'dimension_filters': [ { 'dimension': 'COUNTRY', 'matches_any': {'values': [{'value': 'US', 'value': 'CN'}]} } ], 'sort_conditions': [ {'dimension':'APP', order: 'ASCENDING'}, {'metric':'CLICKS', order: 'DESCENDING'} ], 'localization_settings': { 'currency_code': 'USD', 'language_code': 'en-US' } } For a better understanding, you can treat the preceding specification like the following pseudo SQL: SELECT DATE, APP, COUNTRY, CLICKS, ESTIMATED_EARNINGS FROM NETWORK_REPORT WHERE DATE >= '2018-09-01' AND DATE <= '2018-09-30' AND COUNTRY IN ('US', 'CN') GROUP BY DATE, APP, COUNTRY ORDER BY APP ASC, CLICKS DESC; + */ + export interface Schema$NetworkReportSpec { + /** + * The date range for which the report is generated. + */ + dateRange?: Schema$DateRange; + /** + * Describes which report rows to match based on their dimension values. + */ + dimensionFilters?: Schema$NetworkReportSpecDimensionFilter[]; + /** + * List of dimensions of the report. The value combination of these dimensions determines the row of the report. If no dimensions are specified, the report returns a single row of requested metrics for the entire account. + */ + dimensions?: string[] | null; + /** + * Localization settings of the report. + */ + localizationSettings?: Schema$LocalizationSettings; + /** + * Maximum number of report data rows to return. If the value is not set, the API returns as many rows as possible, up to 100000. Acceptable values are 1-100000, inclusive. Any other values are treated as 100000. + */ + maxReportRows?: number | null; + /** + * List of metrics of the report. A report must specify at least one metric. + */ + metrics?: string[] | null; + /** + * Describes the sorting of report rows. The order of the condition in the list defines its precedence; the earlier the condition, the higher its precedence. If no sort conditions are specified, the row ordering is undefined. + */ + sortConditions?: Schema$NetworkReportSpecSortCondition[]; + /** + * A report time zone. Accepts an IANA TZ name values, such as "America/Los_Angeles." If no time zone is defined, the account default takes effect. Check default value by the get account action. **Warning:** The "America/Los_Angeles" is the only supported value at the moment. + */ + timeZone?: string | null; + } + /** + * Describes which report rows to match based on their dimension values. + */ + export interface Schema$NetworkReportSpecDimensionFilter { + /** + * Applies the filter criterion to the specified dimension. + */ + dimension?: string | null; + /** + * Matches a row if its value for the specified dimension is in one of the values specified in this condition. + */ + matchesAny?: Schema$StringList; + } + /** + * Sorting direction to be applied on a dimension or a metric. + */ + export interface Schema$NetworkReportSpecSortCondition { + /** + * Sort by the specified dimension. + */ + dimension?: string | null; + /** + * Sort by the specified metric. + */ + metric?: string | null; + /** + * Sorting order of the dimension or metric. + */ + order?: string | null; + } + /** + * A publisher account contains information relevant to the use of this API, such as the time zone used for the reports. + */ + export interface Schema$PublisherAccount { + /** + * Currency code of the earning-related metrics, which is the 3-letter code defined in ISO 4217. The daily average rate is used for the currency conversion. + */ + currencyCode?: string | null; + /** + * Resource name of this account. Format is accounts/{publisher_id}. + */ + name?: string | null; + /** + * The unique ID by which this publisher account can be identified in the API requests (for example, pub-1234567890). + */ + publisherId?: string | null; + /** + * The time zone that is used in reports that are generated for this account. The value is a time-zone ID as specified by the CLDR project, for example, "America/Los_Angeles". + */ + reportingTimeZone?: string | null; + } + /** + * Groups data available after report generation, for example, warnings and row counts. Always sent as the last message in the stream response. + */ + export interface Schema$ReportFooter { + /** + * Total number of rows that did match the request. + */ + matchingRowCount?: string | null; + /** + * Warnings associated with generation of the report. + */ + warnings?: Schema$ReportWarning[]; + } + /** + * Groups data helps to treat the generated report. Always sent as a first message in the stream response. + */ + export interface Schema$ReportHeader { + /** + * The date range for which the report is generated. This is identical to the range specified in the report request. + */ + dateRange?: Schema$DateRange; + /** + * Localization settings of the report. This is identical to the settings in the report request. + */ + localizationSettings?: Schema$LocalizationSettings; + /** + * The report time zone. The value is a time-zone ID as specified by the CLDR project, for example, "America/Los_Angeles". + */ + reportingTimeZone?: string | null; + } + /** + * A row of the returning report. + */ + export interface Schema$ReportRow { + /** + * Map of dimension values in a row, with keys as enum name of the dimensions. + */ + dimensionValues?: {[key: string]: Schema$ReportRowDimensionValue} | null; + /** + * Map of metric values in a row, with keys as enum name of the metrics. If a metric being requested has no value returned, the map will not include it. + */ + metricValues?: {[key: string]: Schema$ReportRowMetricValue} | null; + } + /** + * Representation of a dimension value. + */ + export interface Schema$ReportRowDimensionValue { + /** + * The localized string representation of the value. If unspecified, the display label should be derived from the value. + */ + displayLabel?: string | null; + /** + * Dimension value in the format specified in the report's spec Dimension enum. + */ + value?: string | null; + } + /** + * Representation of a metric value. + */ + export interface Schema$ReportRowMetricValue { + /** + * Double precision (approximate) decimal values. Rates are from 0 to 1. + */ + doubleValue?: number | null; + /** + * Metric integer value. + */ + integerValue?: string | null; + /** + * Amount in micros. One million is equivalent to one unit. Currency value is in the unit (USD, EUR or other) specified by the request. For example, $6.50 whould be represented as 6500000 micros. + */ + microsValue?: string | null; + } + /** + * Warnings associated with generation of the report. + */ + export interface Schema$ReportWarning { + /** + * Describes the details of the warning message, in English. + */ + description?: string | null; + /** + * Type of the warning. + */ + type?: string | null; + } + /** + * List of string values. + */ + export interface Schema$StringList { + /** + * The string values. + */ + values?: string[] | null; + } + + export class Resource$Accounts { + context: APIRequestContext; + mediationReport: Resource$Accounts$Mediationreport; + networkReport: Resource$Accounts$Networkreport; + constructor(context: APIRequestContext) { + this.context = context; + this.mediationReport = new Resource$Accounts$Mediationreport( + this.context + ); + this.networkReport = new Resource$Accounts$Networkreport(this.context); + } + + /** + * admob.accounts.get + * @desc Gets information about the specified AdMob publisher account. + * @alias admob.accounts.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Resource name of the publisher account to retrieve. Example: accounts/pub-9876543210987654 + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Accounts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Accounts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Accounts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Accounts$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://admob.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); + } + } + + /** + * admob.accounts.list + * @desc Lists the AdMob publisher account accessible with the client credential. Currently, all credentials have access to at most one AdMob account. + * @alias admob.accounts.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Maximum number of accounts to return. + * @param {string=} params.pageToken The value returned by the last `ListPublisherAccountsResponse`; indicates that this is a continuation of a prior `ListPublisherAccounts` call, and that the system should return the next page of 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$Accounts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Accounts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Accounts$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Accounts$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Accounts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://admob.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/accounts').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Accounts$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name of the publisher account to retrieve. Example: accounts/pub-9876543210987654 + */ + name?: string; + } + export interface Params$Resource$Accounts$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Maximum number of accounts to return. + */ + pageSize?: number; + /** + * The value returned by the last `ListPublisherAccountsResponse`; indicates that this is a continuation of a prior `ListPublisherAccounts` call, and that the system should return the next page of data. + */ + pageToken?: string; + } + + export class Resource$Accounts$Mediationreport { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * admob.accounts.mediationReport.generate + * @desc Generates an AdMob Mediation report based on the provided report specification. + * @alias admob.accounts.mediationReport.generate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654 + * @param {().GenerateMediationReportRequest} params.requestBody Request 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 + */ + generate( + params?: Params$Resource$Accounts$Mediationreport$Generate, + options?: MethodOptions + ): GaxiosPromise; + generate( + params: Params$Resource$Accounts$Mediationreport$Generate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Accounts$Mediationreport$Generate, + callback: BodyResponseCallback + ): void; + generate( + callback: BodyResponseCallback + ): void; + generate( + paramsOrCallback?: + | Params$Resource$Accounts$Mediationreport$Generate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Mediationreport$Generate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Mediationreport$Generate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://admob.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/mediationReport:generate').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$Accounts$Mediationreport$Generate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateMediationReportRequest; + } + + export class Resource$Accounts$Networkreport { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * admob.accounts.networkReport.generate + * @desc Generates an AdMob Network report based on the provided report specification. + * @alias admob.accounts.networkReport.generate + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654 + * @param {().GenerateNetworkReportRequest} params.requestBody Request 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 + */ + generate( + params?: Params$Resource$Accounts$Networkreport$Generate, + options?: MethodOptions + ): GaxiosPromise; + generate( + params: Params$Resource$Accounts$Networkreport$Generate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generate( + params: Params$Resource$Accounts$Networkreport$Generate, + callback: BodyResponseCallback + ): void; + generate( + callback: BodyResponseCallback + ): void; + generate( + paramsOrCallback?: + | Params$Resource$Accounts$Networkreport$Generate + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Networkreport$Generate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Networkreport$Generate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://admob.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/networkReport:generate').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$Accounts$Networkreport$Generate + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Resource name of the account to generate the report for. Example: accounts/pub-9876543210987654 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateNetworkReportRequest; + } +} diff --git a/src/apis/replicapool/webpack.config.js b/src/apis/admob/webpack.config.js similarity index 96% rename from src/apis/replicapool/webpack.config.js rename to src/apis/admob/webpack.config.js index 7e490d4f97..b66820fe5a 100644 --- a/src/apis/replicapool/webpack.config.js +++ b/src/apis/admob/webpack.config.js @@ -22,8 +22,8 @@ module.exports = { extensions: ['.ts', '.js', '.json'], }, output: { - library: 'Replicapool', - filename: 'replicapool.min.js', + library: 'Admob', + filename: 'admob.min.js', path: path.resolve(__dirname, 'dist'), }, node: { diff --git a/src/apis/alertcenter/v1beta1.ts b/src/apis/alertcenter/v1beta1.ts index dc0e96bee1..8ac301fad6 100644 --- a/src/apis/alertcenter/v1beta1.ts +++ b/src/apis/alertcenter/v1beta1.ts @@ -474,6 +474,15 @@ export namespace alertcenter_v1beta1 { */ serialNumber?: string | null; } + /** + * Alerts that get triggered on violations of Data Loss Prevention (DLP) rules. + */ + export interface Schema$DlpRuleViolation { + /** + * Details about the violated DLP rule. Admins can use the predefined detectors provided by Google Cloud DLP https://cloud.google.com/dlp/ when setting up a DLP rule. Matched Cloud DLP detectors in this violation if any will be captured in the MatchInfo.predefined_detector. + */ + ruleViolationInfo?: Schema$RuleViolationInfo; + } /** * Domain ID of Gmail phishing alerts. */ @@ -496,6 +505,40 @@ export namespace alertcenter_v1beta1 { */ takeoutRequestId?: string | null; } + /** + * A Drive file + */ + export interface Schema$DriveFile { + /** + * Abuse type of the file. + */ + abuseType?: string | null; + /** + * The ID of the file. + */ + id?: string | null; + /** + * The name of the file. + */ + name?: string | null; + /** + * The number of recent downloads of the file. This is available for the following alert types: *Drive malware sharing detected + */ + numRecentDownload?: string | null; + /** + * The email address of the file owner. + */ + owner?: string | null; + } + /** + * Alerts for suspicious Drive files or activities. + */ + export interface Schema$DriveFileWarning { + /** + * List of files in the alert. + */ + files?: Schema$DriveFile[]; + } /** * 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 `{}`. */ @@ -594,7 +637,7 @@ export namespace alertcenter_v1beta1 { loginTime?: string | null; } /** - * Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification + * Proto for all phishing alerts with common payload. Supported types are any of the following: * User reported phishing * User reported spam spike * Suspicious message reported * Phishing reclassification * Malware reclassification * Gmail potential employee spoofing */ export interface Schema$MailPhishing { /** @@ -613,6 +656,10 @@ export namespace alertcenter_v1beta1 { * The list of messages contained by this alert. */ messages?: Schema$GmailMessageInfo[]; + /** + * System actions on the messages. + */ + systemActionType?: string | null; } /** * Entity whose actions triggered a Gmail phishing alert. @@ -631,6 +678,19 @@ export namespace alertcenter_v1beta1 { */ fromHeader?: string | null; } + /** + * Proto that contains match information from the condition part of the rule. + */ + export interface Schema$MatchInfo { + /** + * For matched detector predefined by Google. + */ + predefinedDetector?: Schema$PredefinedDetectorInfo; + /** + * For matched detector defined by administrators. + */ + userDefinedDetector?: Schema$UserDefinedDetectorInfo; + } /** * Settings for callback notifications. For more details see [G Suite Alert Notification](/admin-sdk/alertcenter/guides/notifications). */ @@ -661,6 +721,15 @@ export namespace alertcenter_v1beta1 { */ messages?: Schema$GmailMessageInfo[]; } + /** + * Detector provided by Google. + */ + export interface Schema$PredefinedDetectorInfo { + /** + * Name that uniquely identifies the detector. + */ + detectorName?: string | null; + } /** * Requests for one application that needs default SQL setup. */ @@ -678,6 +747,73 @@ export namespace alertcenter_v1beta1 { */ numberOfRequests?: string | null; } + /** + * Proto that contains resource information. + */ + export interface Schema$ResourceInfo { + /** + * Drive file ID. + */ + documentId?: string | null; + /** + * Title of the resource, e.g. email subject, or document title. + */ + resourceTitle?: string | null; + } + /** + * Proto that contains rule information. + */ + export interface Schema$RuleInfo { + /** + * User provided name of the rule. + */ + displayName?: string | null; + /** + * Resource name that uniquely identifies the rule. + */ + resourceName?: string | null; + } + /** + * Common alert information about violated rules that are configured by G Suite administrators. + */ + export interface Schema$RuleViolationInfo { + /** + * Source of the data. + */ + dataSource?: string | null; + /** + * List of matches that were found in the resource content. + */ + matchInfo?: Schema$MatchInfo[]; + /** + * Resource recipients. For Drive, they are grantees that the Drive file was shared with at the time of rule triggering. Valid values include user emails, group emails, domains, or 'anyone' if the file was publicly accessible. If the file was private the recipients list will be empty. For Gmail, they are emails of the users or groups that the Gmail message was sent to. + */ + recipients?: string[] | null; + /** + * Details of the resource which violated the rule. + */ + resourceInfo?: Schema$ResourceInfo; + /** + * Details of the violated rule. + */ + ruleInfo?: Schema$RuleInfo; + /** + * Actions suppressed due to other actions with higher priority. + */ + suppressedActionTypes?: string[] | null; + /** + * Trigger of the rule. + */ + trigger?: string | null; + /** + * Actions applied as a consequence of the rule being triggered. + */ + triggeredActionTypes?: string[] | null; + /** + * Email of the user who caused the violation. Value could be empty if not applicable, for example, a violation found by drive continuous scan. + */ + triggeringUserEmail?: string | null; + } /** * Customer-level settings. */ @@ -789,6 +925,19 @@ export namespace alertcenter_v1beta1 { */ emailAddress?: string | null; } + /** + * Detector defined by administrators. + */ + export interface Schema$UserDefinedDetectorInfo { + /** + * Display name of the detector. + */ + displayName?: string | null; + /** + * Resource name that uniquely identifies the detector. + */ + resourceName?: string | null; + } export class Resource$Alerts { context: APIRequestContext; diff --git a/src/apis/analytics/index.ts b/src/apis/analytics/index.ts index d3658eb681..8d299d86d1 100644 --- a/src/apis/analytics/index.ts +++ b/src/apis/analytics/index.ts @@ -14,31 +14,19 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {analytics_v2_4} from './v2.4'; import {analytics_v3} from './v3'; export const VERSIONS = { - 'v2.4': analytics_v2_4.Analytics, v3: analytics_v3.Analytics, }; -export function analytics(version: 'v2.4'): analytics_v2_4.Analytics; -export function analytics( - options: analytics_v2_4.Options -): analytics_v2_4.Analytics; export function analytics(version: 'v3'): analytics_v3.Analytics; export function analytics( options: analytics_v3.Options ): analytics_v3.Analytics; -export function analytics< - T = analytics_v2_4.Analytics | analytics_v3.Analytics ->( +export function analytics( this: GoogleConfigurable, - versionOrOptions: - | 'v2.4' - | analytics_v2_4.Options - | 'v3' - | analytics_v3.Options + versionOrOptions: 'v3' | analytics_v3.Options ) { return getAPI('analytics', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/analytics/v2.4.ts b/src/apis/analytics/v2.4.ts deleted file mode 100644 index 24c5117146..0000000000 --- a/src/apis/analytics/v2.4.ts +++ /dev/null @@ -1,768 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace analytics_v2_4 { - export interface Options extends GlobalOptions { - version: 'v2.4'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * Google Analytics API - * - * Views and manages your Google Analytics data. - * - * @example - * const {google} = require('googleapis'); - * const analytics = google.analytics('v2.4'); - * - * @namespace analytics - * @type {Function} - * @version v2.4 - * @variation v2.4 - * @param {object=} options Options for Analytics - */ - export class Analytics { - context: APIRequestContext; - data: Resource$Data; - management: Resource$Management; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.data = new Resource$Data(this.context); - this.management = new Resource$Management(this.context); - } - } - - export class Resource$Data { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * analytics.data.get - * @desc Returns Analytics report data for a view (profile). - * @alias analytics.data.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.dimensions A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. - * @param {string} params.end-date End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD. - * @param {string=} params.filters A comma-separated list of dimension or metric filters to be applied to the report data. - * @param {string} params.ids Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - * @param {integer=} params.max-results The maximum number of entries to include in this feed. - * @param {string} params.metrics A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report. - * @param {string=} params.segment An Analytics advanced segment to be applied to the report data. - * @param {string=} params.sort A comma-separated list of dimensions or metrics that determine the sort order for the report data. - * @param {string} params.start-date Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [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$Data$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Data$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Data$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: Params$Resource$Data$Get | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Data$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Data$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/analytics/v2.4/data').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['ids', 'start-date', 'end-date', 'metrics'], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Data$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * A comma-separated list of Analytics dimensions. E.g., 'ga:browser,ga:city'. - */ - dimensions?: string; - /** - * End date for fetching report data. All requests should specify an end date formatted as YYYY-MM-DD. - */ - 'end-date'?: string; - /** - * A comma-separated list of dimension or metric filters to be applied to the report data. - */ - filters?: string; - /** - * Unique table ID for retrieving report data. Table ID is of the form ga:XXXX, where XXXX is the Analytics view (profile) ID. - */ - ids?: string; - /** - * The maximum number of entries to include in this feed. - */ - 'max-results'?: number; - /** - * A comma-separated list of Analytics metrics. E.g., 'ga:sessions,ga:pageviews'. At least one metric must be specified to retrieve a valid Analytics report. - */ - metrics?: string; - /** - * An Analytics advanced segment to be applied to the report data. - */ - segment?: string; - /** - * A comma-separated list of dimensions or metrics that determine the sort order for the report data. - */ - sort?: string; - /** - * Start date for fetching report data. All requests should specify a start date formatted as YYYY-MM-DD. - */ - 'start-date'?: string; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - - export class Resource$Management { - context: APIRequestContext; - accounts: Resource$Management$Accounts; - goals: Resource$Management$Goals; - profiles: Resource$Management$Profiles; - segments: Resource$Management$Segments; - webproperties: Resource$Management$Webproperties; - constructor(context: APIRequestContext) { - this.context = context; - this.accounts = new Resource$Management$Accounts(this.context); - this.goals = new Resource$Management$Goals(this.context); - this.profiles = new Resource$Management$Profiles(this.context); - this.segments = new Resource$Management$Segments(this.context); - this.webproperties = new Resource$Management$Webproperties(this.context); - } - } - - export class Resource$Management$Accounts { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * analytics.management.accounts.list - * @desc Lists all accounts to which the user has access. - * @alias analytics.management.accounts.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {integer=} params.max-results The maximum number of accounts to include in this response. - * @param {integer=} params.start-index An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [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$Management$Accounts$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Management$Accounts$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Accounts$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Accounts$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Accounts$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Accounts$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/analytics/v2.4/management/accounts').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Accounts$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The maximum number of accounts to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first account to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - - export class Resource$Management$Goals { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * analytics.management.goals.list - * @desc Lists goals to which the user has access. - * @alias analytics.management.goals.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - * @param {integer=} params.max-results The maximum number of goals to include in this response. - * @param {string} params.profileId View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. - * @param {integer=} params.start-index An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - * @param {object} [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$Management$Goals$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Management$Goals$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Goals$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Goals$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Goals$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Goals$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v2.4/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles/{profileId}/goals' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId', 'profileId'], - pathParams: ['accountId', 'profileId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Goals$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account ID to retrieve goals for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - */ - accountId?: string; - /** - * The maximum number of goals to include in this response. - */ - 'max-results'?: number; - /** - * View (Profile) ID to retrieve goals for. Can either be a specific view (profile) ID or '~all', which refers to all the views (profiles) that user has access to. - */ - profileId?: string; - /** - * An index of the first goal to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID to retrieve goals for. Can either be a specific web property ID or '~all', which refers to all the web properties that user has access to. - */ - webPropertyId?: string; - } - - export class Resource$Management$Profiles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * analytics.management.profiles.list - * @desc Lists views (profiles) to which the user has access. - * @alias analytics.management.profiles.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.accountId Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. - * @param {integer=} params.max-results The maximum number of views (profiles) to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {string} params.webPropertyId Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. - * @param {object} [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$Management$Profiles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Management$Profiles$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Profiles$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Profiles$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Profiles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Profiles$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v2.4/management/accounts/{accountId}/webproperties/{webPropertyId}/profiles' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['accountId', 'webPropertyId'], - pathParams: ['accountId', 'webPropertyId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Profiles$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account ID for the views (profiles) to retrieve. Can either be a specific account ID or '~all', which refers to all the accounts to which the user has access. - */ - accountId?: string; - /** - * The maximum number of views (profiles) to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - /** - * Web property ID for the views (profiles) to retrieve. Can either be a specific web property ID or '~all', which refers to all the web properties to which the user has access. - */ - webPropertyId?: string; - } - - export class Resource$Management$Segments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * analytics.management.segments.list - * @desc Lists advanced segments to which the user has access. - * @alias analytics.management.segments.list - * @memberOf! () - * - * @param {object=} params Parameters for request - * @param {integer=} params.max-results The maximum number of advanced segments to include in this response. - * @param {integer=} params.start-index An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [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$Management$Segments$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Management$Segments$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Segments$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Segments$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Segments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Segments$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/analytics/v2.4/management/segments').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Segments$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The maximum number of advanced segments to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first advanced segment to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } - - export class Resource$Management$Webproperties { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * analytics.management.webproperties.list - * @desc Lists web properties to which the user has access. - * @alias analytics.management.webproperties.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.accountId Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - * @param {integer=} params.max-results The maximum number of web properties to include in this response. - * @param {integer=} params.start-index An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - * @param {object} [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$Management$Webproperties$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Management$Webproperties$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Management$Webproperties$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Management$Webproperties$List - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Management$Webproperties$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Management$Webproperties$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/analytics/v2.4/management/accounts/{accountId}/webproperties' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['accountId'], - pathParams: ['accountId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Management$Webproperties$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Account ID to retrieve web properties for. Can either be a specific account ID or '~all', which refers to all the accounts that user has access to. - */ - accountId?: string; - /** - * The maximum number of web properties to include in this response. - */ - 'max-results'?: number; - /** - * An index of the first entity to retrieve. Use this parameter as a pagination mechanism along with the max-results parameter. - */ - 'start-index'?: number; - } -} diff --git a/src/apis/androidenterprise/v1.ts b/src/apis/androidenterprise/v1.ts index 0b86a0c39a..9a8c548069 100644 --- a/src/apis/androidenterprise/v1.ts +++ b/src/apis/androidenterprise/v1.ts @@ -747,6 +747,9 @@ export namespace androidenterprise_v1 { * Contains the ID of the managed configuration profile and the set of configuration variables (if any) defined for the user. */ configurationVariables?: Schema$ConfigurationVariables; + /** + * Deprecated. + */ kind?: string | null; /** * The set of managed properties for this configuration. @@ -1049,6 +1052,10 @@ export namespace androidenterprise_v1 { * How and to whom the package is made available. The value publicGoogleHosted means that the package is available through the Play store and not restricted to a specific enterprise. The value privateGoogleHosted means that the package is a private app (restricted to an enterprise) but hosted by Google. The value privateSelfHosted means that the package is a private app (restricted to an enterprise) and is privately hosted. */ distributionChannel?: string | null; + /** + * Noteworthy features (if any) of this product. + */ + features?: string[] | null; /** * A link to an image that can be used as an icon for the product. This image is suitable for use at up to 512px x 512px. */ @@ -1845,81 +1852,6 @@ export namespace androidenterprise_v1 { } } - /** - * androidenterprise.devices.patch - * @desc Updates the device policy. This method supports patch semantics. - * @alias androidenterprise.devices.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.deviceId The ID of the device. - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string=} params.updateMask Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,... - * @param {string} params.userId The ID of the user. - * @param {().Device} params.requestBody Request 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$Devices$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Devices$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Devices$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Devices$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Devices$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Devices$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['enterpriseId', 'userId', 'deviceId'], - pathParams: ['deviceId', 'enterpriseId', 'userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * androidenterprise.devices.setState * @desc Sets whether a device's access to Google services is enabled or disabled. The device state takes effect only if enforcing EMM policies on Android devices is enabled in the Google Admin Console. Otherwise, the device state is ignored and all devices are allowed access to Google services. This is only supported for Google-managed users. @@ -2145,34 +2077,6 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Devices$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the device. - */ - deviceId?: string; - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * Mask that identifies which fields to update. If not set, all modifiable fields will be modified. When set in a query parameter, this field should be specified as updateMask=,,... - */ - updateMask?: string; - /** - * The ID of the user. - */ - userId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Device; - } export interface Params$Resource$Devices$Setstate extends StandardParameters { /** * Auth client or API Key for the request @@ -3727,84 +3631,6 @@ export namespace androidenterprise_v1 { } } - /** - * androidenterprise.entitlements.patch - * @desc Adds or updates an entitlement to an app for a user. This method supports patch semantics. - * @alias androidenterprise.entitlements.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.entitlementId The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". - * @param {boolean=} params.install Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user. - * @param {string} params.userId The ID of the user. - * @param {().Entitlement} params.requestBody Request 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$Entitlements$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Entitlements$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Entitlements$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Entitlements$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Entitlements$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Entitlements$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/entitlements/{entitlementId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['enterpriseId', 'userId', 'entitlementId'], - pathParams: ['enterpriseId', 'entitlementId', 'userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * androidenterprise.entitlements.update * @desc Adds or updates an entitlement to an app for a user. @@ -3939,35 +3765,6 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Entitlements$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * The ID of the entitlement (a product ID), e.g. "app:com.google.android.gm". - */ - entitlementId?: string; - /** - * Set to true to also install the product on all the user's devices where possible. Failure to install on one or more devices will not prevent this operation from returning successfully, as long as the entitlement was successfully assigned to the user. - */ - install?: boolean; - /** - * The ID of the user. - */ - userId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Entitlement; - } export interface Params$Resource$Entitlements$Update extends StandardParameters { /** @@ -4529,81 +4326,6 @@ export namespace androidenterprise_v1 { } } - /** - * androidenterprise.installs.patch - * @desc Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. This method supports patch semantics. - * @alias androidenterprise.installs.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.deviceId The Android ID of the device. - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.installId The ID of the product represented by the install, e.g. "app:com.google.android.gm". - * @param {string} params.userId The ID of the user. - * @param {().Install} params.requestBody Request 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$Installs$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Installs$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Installs$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Installs$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Installs$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Installs$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/installs/{installId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['enterpriseId', 'userId', 'deviceId', 'installId'], - pathParams: ['deviceId', 'enterpriseId', 'installId', 'userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * androidenterprise.installs.update * @desc Requests to install the latest version of an app to a device. If the app is already installed, then it is updated to the latest version if necessary. @@ -4745,7 +4467,7 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Installs$Patch extends StandardParameters { + export interface Params$Resource$Installs$Update extends StandardParameters { /** * Auth client or API Key for the request */ @@ -4773,40 +4495,12 @@ export namespace androidenterprise_v1 { */ requestBody?: Schema$Install; } - export interface Params$Resource$Installs$Update extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The Android ID of the device. - */ - deviceId?: string; - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * The ID of the product represented by the install, e.g. "app:com.google.android.gm". - */ - installId?: string; - /** - * The ID of the user. - */ - userId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Install; - } - - export class Resource$Managedconfigurationsfordevice { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } + + export class Resource$Managedconfigurationsfordevice { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** * androidenterprise.managedconfigurationsfordevice.delete @@ -5081,96 +4775,6 @@ export namespace androidenterprise_v1 { } } - /** - * androidenterprise.managedconfigurationsfordevice.patch - * @desc Adds or updates a per-device managed configuration for an app for the specified device. This method supports patch semantics. - * @alias androidenterprise.managedconfigurationsfordevice.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.deviceId The Android ID of the device. - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForDeviceId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". - * @param {string} params.userId The ID of the user. - * @param {().ManagedConfiguration} params.requestBody Request 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$Managedconfigurationsfordevice$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Managedconfigurationsfordevice$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Managedconfigurationsfordevice$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Managedconfigurationsfordevice$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Managedconfigurationsfordevice$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Managedconfigurationsfordevice$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/devices/{deviceId}/managedConfigurationsForDevice/{managedConfigurationForDeviceId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: [ - 'enterpriseId', - 'userId', - 'deviceId', - 'managedConfigurationForDeviceId', - ], - pathParams: [ - 'deviceId', - 'enterpriseId', - 'managedConfigurationForDeviceId', - 'userId', - ], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * androidenterprise.managedconfigurationsfordevice.update * @desc Adds or updates a per-device managed configuration for an app for the specified device. @@ -5330,35 +4934,6 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Managedconfigurationsfordevice$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The Android ID of the device. - */ - deviceId?: string; - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". - */ - managedConfigurationForDeviceId?: string; - /** - * The ID of the user. - */ - userId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ManagedConfiguration; - } export interface Params$Resource$Managedconfigurationsfordevice$Update extends StandardParameters { /** @@ -5647,89 +5222,6 @@ export namespace androidenterprise_v1 { } } - /** - * androidenterprise.managedconfigurationsforuser.patch - * @desc Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. This method supports patch semantics. - * @alias androidenterprise.managedconfigurationsforuser.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.managedConfigurationForUserId The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". - * @param {string} params.userId The ID of the user. - * @param {().ManagedConfiguration} params.requestBody Request 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$Managedconfigurationsforuser$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Managedconfigurationsforuser$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Managedconfigurationsforuser$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Managedconfigurationsforuser$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Managedconfigurationsforuser$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Managedconfigurationsforuser$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}/managedConfigurationsForUser/{managedConfigurationForUserId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: [ - 'enterpriseId', - 'userId', - 'managedConfigurationForUserId', - ], - pathParams: ['enterpriseId', 'managedConfigurationForUserId', 'userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * androidenterprise.managedconfigurationsforuser.update * @desc Adds or updates the managed configuration settings for an app for the specified user. If you support the Managed configurations iframe, you can apply managed configurations to a user by specifying an mcmId and its associated configuration variables (if any) in the request. Alternatively, all EMMs can apply managed configurations by passing a list of managed properties. @@ -5870,31 +5362,6 @@ export namespace androidenterprise_v1 { */ userId?: string; } - export interface Params$Resource$Managedconfigurationsforuser$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * The ID of the managed configuration (a product ID), e.g. "app:com.google.android.gm". - */ - managedConfigurationForUserId?: string; - /** - * The ID of the user. - */ - userId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ManagedConfiguration; - } export interface Params$Resource$Managedconfigurationsforuser$Update extends StandardParameters { /** @@ -7433,9 +6900,9 @@ export namespace androidenterprise_v1 { } /** - * androidenterprise.storelayoutclusters.patch - * @desc Updates a cluster. This method supports patch semantics. - * @alias androidenterprise.storelayoutclusters.patch + * androidenterprise.storelayoutclusters.update + * @desc Updates a cluster. + * @alias androidenterprise.storelayoutclusters.update * @memberOf! () * * @param {object} params Parameters for request @@ -7447,23 +6914,23 @@ export namespace androidenterprise_v1 { * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - patch( - params?: Params$Resource$Storelayoutclusters$Patch, + update( + params?: Params$Resource$Storelayoutclusters$Update, options?: MethodOptions ): GaxiosPromise; - patch( - params: Params$Resource$Storelayoutclusters$Patch, + update( + params: Params$Resource$Storelayoutclusters$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Storelayoutclusters$Patch, + update( + params: Params$Resource$Storelayoutclusters$Update, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + update(callback: BodyResponseCallback): void; + update( paramsOrCallback?: - | Params$Resource$Storelayoutclusters$Patch + | Params$Resource$Storelayoutclusters$Update | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -7471,12 +6938,12 @@ export namespace androidenterprise_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Storelayoutclusters$Patch; + {}) as Params$Resource$Storelayoutclusters$Update; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Storelayoutclusters$Patch; + params = {} as Params$Resource$Storelayoutclusters$Update; options = {}; } @@ -7493,7 +6960,7 @@ export namespace androidenterprise_v1 { rootUrl + '/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'PUT', }, options ), @@ -7508,89 +6975,12 @@ export namespace androidenterprise_v1 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Storelayoutclusters$Delete + extends StandardParameters { /** - * androidenterprise.storelayoutclusters.update - * @desc Updates a cluster. - * @alias androidenterprise.storelayoutclusters.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.clusterId The ID of the cluster. - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.pageId The ID of the page. - * @param {().StoreCluster} params.requestBody Request 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$Storelayoutclusters$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Storelayoutclusters$Update, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Storelayoutclusters$Update, - callback: BodyResponseCallback - ): void; - update(callback: BodyResponseCallback): void; - update( - paramsOrCallback?: - | Params$Resource$Storelayoutclusters$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Storelayoutclusters$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Storelayoutclusters$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}/clusters/{clusterId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['enterpriseId', 'pageId', 'clusterId'], - pathParams: ['clusterId', 'enterpriseId', 'pageId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Storelayoutclusters$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request + * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; @@ -7664,31 +7054,6 @@ export namespace androidenterprise_v1 { */ pageId?: string; } - export interface Params$Resource$Storelayoutclusters$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the cluster. - */ - clusterId?: string; - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * The ID of the page. - */ - pageId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StoreCluster; - } export interface Params$Resource$Storelayoutclusters$Update extends StandardParameters { /** @@ -8027,82 +7392,6 @@ export namespace androidenterprise_v1 { } } - /** - * androidenterprise.storelayoutpages.patch - * @desc Updates the content of a store page. This method supports patch semantics. - * @alias androidenterprise.storelayoutpages.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.pageId The ID of the page. - * @param {().StorePage} params.requestBody Request 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$Storelayoutpages$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Storelayoutpages$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Storelayoutpages$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Storelayoutpages$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Storelayoutpages$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Storelayoutpages$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/storeLayout/pages/{pageId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['enterpriseId', 'pageId'], - pathParams: ['enterpriseId', 'pageId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * androidenterprise.storelayoutpages.update * @desc Updates the content of a store page. @@ -8241,27 +7530,6 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Storelayoutpages$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * The ID of the page. - */ - pageId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$StorePage; - } export interface Params$Resource$Storelayoutpages$Update extends StandardParameters { /** @@ -8807,79 +8075,6 @@ export namespace androidenterprise_v1 { } } - /** - * androidenterprise.users.patch - * @desc Updates the details of an EMM-managed user. Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value. This method supports patch semantics. - * @alias androidenterprise.users.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.userId The ID of the user. - * @param {().User} params.requestBody Request 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$Users$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Users$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Users$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Users$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Users$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Users$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/users/{userId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['enterpriseId', 'userId'], - pathParams: ['enterpriseId', 'userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * androidenterprise.users.revokeDeviceAccess * @desc Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices. This call only works with EMM-managed accounts. @@ -9287,26 +8482,6 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Users$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * The ID of the user. - */ - userId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$User; - } export interface Params$Resource$Users$Revokedeviceaccess extends StandardParameters { /** @@ -9676,79 +8851,6 @@ export namespace androidenterprise_v1 { } } - /** - * androidenterprise.webapps.patch - * @desc Updates an existing web app. This method supports patch semantics. - * @alias androidenterprise.webapps.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.enterpriseId The ID of the enterprise. - * @param {string} params.webAppId The ID of the web app. - * @param {().WebApp} params.requestBody Request 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$Webapps$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Webapps$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Webapps$Patch, - callback: BodyResponseCallback - ): void; - patch(callback: BodyResponseCallback): void; - patch( - paramsOrCallback?: - | Params$Resource$Webapps$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Webapps$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Webapps$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/androidenterprise/v1/enterprises/{enterpriseId}/webApps/{webAppId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['enterpriseId', 'webAppId'], - pathParams: ['enterpriseId', 'webAppId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * androidenterprise.webapps.update * @desc Updates an existing web app. @@ -9880,26 +8982,6 @@ export namespace androidenterprise_v1 { */ enterpriseId?: string; } - export interface Params$Resource$Webapps$Patch extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the enterprise. - */ - enterpriseId?: string; - /** - * The ID of the web app. - */ - webAppId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$WebApp; - } export interface Params$Resource$Webapps$Update extends StandardParameters { /** * Auth client or API Key for the request diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 6b881e3a91..057e6abb83 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -858,6 +858,10 @@ export namespace androidmanagement_v1 { * Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. */ export interface Schema$KioskCustomization { + /** + * Specifies whether the Settings app is allowed in kiosk mode. + */ + deviceSettings?: string | null; /** * Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. */ @@ -1350,7 +1354,7 @@ export namespace androidmanagement_v1 { */ kioskCustomization?: Schema$KioskCustomization; /** - * Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. The status bar is disabled when this is set. + * Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior. */ kioskCustomLauncherEnabled?: boolean | null; /** diff --git a/src/apis/androidpublisher/v2.ts b/src/apis/androidpublisher/v2.ts index 21ddb3d58e..9203b8176e 100644 --- a/src/apis/androidpublisher/v2.ts +++ b/src/apis/androidpublisher/v2.ts @@ -443,10 +443,6 @@ export namespace androidpublisher_v2 { * Purchase type enum value. Unmodifiable after creation. */ purchaseType?: string | null; - /** - * Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - */ - season?: Schema$Season; /** * The stock-keeping-unit (SKU) of the product, unique within an app. */ @@ -503,16 +499,6 @@ export namespace androidpublisher_v2 { kind?: string | null; listings?: Schema$Listing[]; } - export interface Schema$MonthDay { - /** - * Day of a month, value in [1, 31] range. Valid range depends on the specified month. - */ - day?: number | null; - /** - * Month of a year. e.g. 1 = JAN, 2 = FEB etc. - */ - month?: number | null; - } export interface Schema$PageInfo { resultPerPage?: number | null; startIndex?: number | null; @@ -561,16 +547,6 @@ export namespace androidpublisher_v2 { */ purchaseType?: number | null; } - export interface Schema$Prorate { - /** - * Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. - */ - defaultPrice?: Schema$Price; - /** - * Defines the first day on which the price takes effect. - */ - start?: Schema$MonthDay; - } export interface Schema$Review { /** * The name of the user who wrote the review. @@ -609,20 +585,6 @@ export namespace androidpublisher_v2 { export interface Schema$ReviewsReplyResponse { result?: Schema$ReviewReplyResult; } - export interface Schema$Season { - /** - * Inclusive end date of the recurrence period. - */ - end?: Schema$MonthDay; - /** - * Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. - */ - prorations?: Schema$Prorate[]; - /** - * Inclusive start date of the recurrence period. - */ - start?: Schema$MonthDay; - } /** * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). */ @@ -739,7 +701,7 @@ export namespace androidpublisher_v2 { */ profileName?: string | null; /** - * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) + * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) */ purchaseType?: number | null; /** diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 360a9c0ef8..05b0079e23 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -118,6 +118,7 @@ export namespace androidpublisher_v3 { * Information about the binary payload of this APK. */ binary?: Schema$ApkBinary; + testBinary?: Schema$ApkBinary; /** * The version code of the APK, as specified in the APK's manifest file. */ @@ -219,6 +220,7 @@ export namespace androidpublisher_v3 { } export interface Schema$Control { modRanges?: Schema$ModRange[]; + stratifiedSamplings?: Schema$StratifiedSampling[]; versionCodes?: string[] | null; } export interface Schema$CountryTargeting { @@ -445,10 +447,6 @@ export namespace androidpublisher_v3 { * Purchase type enum value. Unmodifiable after creation. */ purchaseType?: string | null; - /** - * Definition of a season for a seasonal subscription. Can be defined only for yearly subscriptions. - */ - season?: Schema$Season; /** * The stock-keeping-unit (SKU) of the product, unique within an app. */ @@ -557,16 +555,6 @@ export namespace androidpublisher_v3 { end?: string | null; start?: string | null; } - export interface Schema$MonthDay { - /** - * Day of a month, value in [1, 31] range. Valid range depends on the specified month. - */ - day?: number | null; - /** - * Month of a year. e.g. 1 = JAN, 2 = FEB etc. - */ - month?: number | null; - } export interface Schema$PageInfo { resultPerPage?: number | null; startIndex?: number | null; @@ -637,16 +625,6 @@ export namespace androidpublisher_v3 { */ developerPayload?: string | null; } - export interface Schema$Prorate { - /** - * Default price cannot be zero and must be less than the full subscription price. Default price is always in the developer's Checkout merchant currency. Targeted countries have their prices set automatically based on the default_price. - */ - defaultPrice?: Schema$Price; - /** - * Defines the first day on which the price takes effect. - */ - start?: Schema$MonthDay; - } export interface Schema$Review { /** * The name of the user who wrote the review. @@ -689,20 +667,15 @@ export namespace androidpublisher_v3 { modRanges?: Schema$ModRange[]; modulus?: string | null; salt?: number | null; + stratifiedSamplings?: Schema$StratifiedSampling[]; + useAndroidId?: boolean | null; } - export interface Schema$Season { - /** - * Inclusive end date of the recurrence period. - */ - end?: Schema$MonthDay; - /** - * Optionally present list of prorations for the season. Each proration is a one-off discounted entry into a subscription. Each proration contains the first date on which the discount is available and the new pricing information. - */ - prorations?: Schema$Prorate[]; - /** - * Inclusive start date of the recurrence period. - */ - start?: Schema$MonthDay; + export interface Schema$StratifiedSampling { + modRanges?: Schema$ModRange[]; + stratum?: Schema$Stratum; + } + export interface Schema$Stratum { + brand?: string | null; } /** * Information provided by the user when they complete the subscription cancellation flow (cancellation reason survey). @@ -783,6 +756,10 @@ export namespace androidpublisher_v3 { * Time at which the subscription will expire, in milliseconds since the Epoch. */ expiryTimeMillis?: string | null; + /** + * User account identifier in the third-party service. Only present if account linking happened as part of the subscription purchase flow. + */ + externalAccountId?: string | null; /** * The family name of the user when the subscription was purchased. Only present for purchases made with 'Subscribe with Google'. */ @@ -832,7 +809,15 @@ export namespace androidpublisher_v3 { */ profileName?: string | null; /** - * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) + * The promotion code applied on this purchase. This field is only set if a vanity code promotion is applied when the subscription was purchased. + */ + promotionCode?: string | null; + /** + * The type of promotion applied on this purchase. This field is only set if a promotion is applied when the subscription was purchased. Possible values are: - One time code - Vanity code + */ + promotionType?: number | null; + /** + * The type of purchase of the subscription. This field is only set if this purchase was not made using the standard in-app billing flow. Possible values are: - Test (i.e. purchased from a license testing account) - Promo (i.e. purchased using a promo code) */ purchaseType?: number | null; /** @@ -869,6 +854,9 @@ export namespace androidpublisher_v3 { variants?: Schema$Variant[]; } export interface Schema$Testers { + autoEnrolledAndroidGroups?: string[] | null; + autoEnrolledGoogleGroups?: string[] | null; + excludedGoogleGroups?: string[] | null; /** * A list of all Google Groups, as email addresses, that define testers for this track. */ @@ -895,14 +883,20 @@ export namespace androidpublisher_v3 { export interface Schema$TrackRelease { controls?: Schema$Control[]; countryTargeting?: Schema$CountryTargeting; + /** + * In-app update priority of the release. All newly added APKs in the release will be considered at this priority. in_app_update_priority can take values between [0, 5]. 5 is the highest priority. Default priority is 0. See https://developer.android.com/guide/playcore/in-app-updates. + */ + inAppUpdatePriority?: number | null; /** * The release name, used to identify this release in the Play Console UI. Not required to be unique. This is optional, if not set it will be generated from the version_name in the APKs. */ name?: string | null; + pinnedVersions?: Schema$TrackReleasePin[]; /** * The description of what is new in the app in this release. */ releaseNotes?: Schema$LocalizedText[]; + rollbackEnabled?: boolean | null; sampling?: Schema$Sampling; /** * The desired status of this release. @@ -917,6 +911,21 @@ export namespace androidpublisher_v3 { */ versionCodes?: string[] | null; } + export interface Schema$TrackReleasePin { + targetings?: Schema$TrackReleasePinPinTargeting[]; + versionCodes?: string[] | null; + } + export interface Schema$TrackReleasePinPinTargeting { + countryCodes?: string[] | null; + devices?: Schema$TrackReleasePinPinTargetingDevicePin[]; + phoneskyVersions?: string[] | null; + sdkVersions?: number[] | null; + } + export interface Schema$TrackReleasePinPinTargetingDevicePin { + brand?: string | null; + device?: string | null; + product?: string | null; + } export interface Schema$TracksListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "androidpublisher#tracksListResponse". diff --git a/src/apis/appengine/v1beta.ts b/src/apis/appengine/v1beta.ts index 7f3cc2c779..13fcddb95b 100644 --- a/src/apis/appengine/v1beta.ts +++ b/src/apis/appengine/v1beta.ts @@ -681,10 +681,6 @@ export namespace appengine_v1beta { * OAuth2 client ID to use for the authentication flow. */ oauth2ClientId?: string | null; - /** - * InputOnly OAuth client info required to generate client id to be used for IAP. - */ - oauth2ClientInfo?: Schema$OAuth2ClientInfo; /** * OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly */ @@ -1032,20 +1028,6 @@ export namespace appengine_v1beta { */ targetSentPacketsPerSecond?: number | null; } - export interface Schema$OAuth2ClientInfo { - /** - * Application name to be used in OAuth consent screen. - */ - applicationName?: string | null; - /** - * Nameof the client to be generated. Optional - If not provided, the name will be autogenerated by the backend. - */ - clientName?: string | null; - /** - * Developer's information to be used in OAuth consent screen. - */ - developerEmailAddress?: string | null; - } /** * This resource represents a long-running operation that is the result of a network API call. */ diff --git a/src/apis/bigquery/v2.ts b/src/apis/bigquery/v2.ts index 64de4d1308..e009de7a4d 100644 --- a/src/apis/bigquery/v2.ts +++ b/src/apis/bigquery/v2.ts @@ -416,15 +416,15 @@ export namespace bigquery_v2 { * [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run. */ trainingOptions?: { - lineSearchInitLearnRate?: number; - earlyStop?: boolean; l1Reg?: number; maxIteration?: string; learnRate?: number; minRelProgress?: number; l2Reg?: number; - learnRateStrategy?: string; warmStart?: boolean; + learnRateStrategy?: string; + lineSearchInitLearnRate?: number; + earlyStop?: boolean; } | null; } /** @@ -550,13 +550,13 @@ export namespace bigquery_v2 { * [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; */ access?: Array<{ - domain?: string; + view?: Schema$TableReference; + groupByEmail?: string; userByEmail?: string; + domain?: string; iamMember?: string; specialGroup?: string; role?: string; - view?: Schema$TableReference; - groupByEmail?: string; }> | null; /** * [Output-only] The time when this dataset was created, in milliseconds since the epoch. @@ -1400,6 +1400,7 @@ export namespace bigquery_v2 { * List of jobs that were requested. */ jobs?: Array<{ + configuration?: Schema$JobConfiguration; user_email?: string; errorResult?: Schema$ErrorProto; kind?: string; @@ -1408,7 +1409,6 @@ export namespace bigquery_v2 { state?: string; statistics?: Schema$JobStatistics; id?: string; - configuration?: Schema$JobConfiguration; }> | null; /** * The resource type of the response. @@ -1473,7 +1473,7 @@ export namespace bigquery_v2 { /** * [Output-only] Job resource usage breakdown by reservation. */ - reservationUsage?: Array<{slotMs?: string; name?: string}> | null; + reservationUsage?: Array<{name?: string; slotMs?: string}> | null; /** * [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job. */ @@ -1803,11 +1803,11 @@ export namespace bigquery_v2 { * Projects to which you have at least READ access. */ projects?: Array<{ + numericId?: string; + kind?: string; id?: string; projectReference?: Schema$ProjectReference; friendlyName?: string; - numericId?: string; - kind?: string; }> | null; /** * The total number of projects in the list. @@ -1843,9 +1843,9 @@ export namespace bigquery_v2 { * [Optional] The types of the fields of this struct, in order, if this is a struct. */ structTypes?: Array<{ + type?: Schema$QueryParameterType; name?: string; description?: string; - type?: Schema$QueryParameterType; }> | null; /** * [Required] The top level type of this field. @@ -1992,7 +1992,7 @@ export namespace bigquery_v2 { /** * [TrustedTester] [Required] Defines the ranges for range partitioning. */ - range?: {start?: string; end?: string; interval?: string} | null; + range?: {interval?: string; start?: string; end?: string} | null; } /** * Evaluation metrics for regression and explicit feedback type matrix factorization models. @@ -2393,8 +2393,8 @@ export namespace bigquery_v2 { * Tables in the requested dataset. */ tables?: Array<{ - type?: string; clustering?: Schema$Clustering; + type?: string; expirationTime?: string; kind?: string; view?: {useLegacySql?: boolean}; diff --git a/src/apis/bigqueryconnection/v1beta1.ts b/src/apis/bigqueryconnection/v1beta1.ts index 80fbb04773..f1db754d0c 100644 --- a/src/apis/bigqueryconnection/v1beta1.ts +++ b/src/apis/bigqueryconnection/v1beta1.ts @@ -239,23 +239,23 @@ export namespace bigqueryconnection_v1beta1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/bigquerydatatransfer/v1.ts b/src/apis/bigquerydatatransfer/v1.ts index bf2111384b..9424434053 100644 --- a/src/apis/bigquerydatatransfer/v1.ts +++ b/src/apis/bigquerydatatransfer/v1.ts @@ -274,6 +274,15 @@ export namespace bigquerydatatransfer_v1 { */ validationRegex?: string | null; } + /** + * Represents preferences for sending email notifications for transfer run events. + */ + export interface Schema$EmailPreferences { + /** + * If true, email notifications will be sent on transfer run failures. + */ + enableFailureEmail?: boolean | null; + } /** * 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 `{}`. */ @@ -487,6 +496,10 @@ export namespace bigquerydatatransfer_v1 { * User specified display name for the data transfer. */ displayName?: string | null; + /** + * Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. + */ + emailPreferences?: Schema$EmailPreferences; /** * The resource name of the transfer config. Transfer config names have the form of `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. The name is automatically generated based on the config_id specified in CreateTransferConfigRequest along with project_id and region. If config_id is not provided, usually a uuid, even though it is not guaranteed or required, will be generated for config_id. */ @@ -495,6 +508,10 @@ export namespace bigquerydatatransfer_v1 { * Output only. Next time when data transfer will run. */ nextRunTime?: string | null; + /** + * Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. + */ + notificationPubsubTopic?: string | null; /** * Data transfer specific parameters. */ @@ -549,6 +566,10 @@ export namespace bigquerydatatransfer_v1 { * Output only. The BigQuery target dataset id. */ destinationDatasetId?: string | null; + /** + * Output only. Email notifications will be sent according to these preferences to the email address of the user who owns the transfer config this run was derived from. + */ + emailPreferences?: Schema$EmailPreferences; /** * Output only. Time when transfer run ended. Parameter ignored by server for input requests. */ @@ -561,6 +582,10 @@ export namespace bigquerydatatransfer_v1 { * The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. */ name?: string | null; + /** + * Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes + */ + notificationPubsubTopic?: string | null; /** * Output only. Data transfer specific parameters. */ diff --git a/src/apis/bigqueryreservation/v1.ts b/src/apis/bigqueryreservation/v1.ts index 4547003cb0..2aa9351661 100644 --- a/src/apis/bigqueryreservation/v1.ts +++ b/src/apis/bigqueryreservation/v1.ts @@ -132,15 +132,6 @@ export namespace bigqueryreservation_v1 { */ operations?: Schema$Operation[]; } - /** - * BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses. - */ - export interface Schema$LocationMetadata { - /** - * The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations. - */ - legacyLocationId?: string | null; - } /** * This resource represents a long-running operation that is the result of a network API call. */ diff --git a/src/apis/bigqueryreservation/v1alpha2.ts b/src/apis/bigqueryreservation/v1alpha2.ts index 44e1efa8f3..4b4cc898ff 100644 --- a/src/apis/bigqueryreservation/v1alpha2.ts +++ b/src/apis/bigqueryreservation/v1alpha2.ts @@ -167,15 +167,6 @@ export namespace bigqueryreservation_v1alpha2 { */ slotPools?: Schema$SlotPool[]; } - /** - * BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses. - */ - export interface Schema$LocationMetadata { - /** - * The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations. - */ - legacyLocationId?: string | null; - } /** * This resource represents a long-running operation that is the result of a network API call. */ diff --git a/src/apis/bigqueryreservation/v1beta1.ts b/src/apis/bigqueryreservation/v1beta1.ts index d8795b9a31..f90e82dcdb 100644 --- a/src/apis/bigqueryreservation/v1beta1.ts +++ b/src/apis/bigqueryreservation/v1beta1.ts @@ -212,19 +212,6 @@ export namespace bigqueryreservation_v1beta1 { */ nextPageToken?: string | null; } - /** - * 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 | null; - } /** * The response for ReservationService.ListReservations. */ @@ -238,40 +225,6 @@ export namespace bigqueryreservation_v1beta1 { */ reservations?: Schema$Reservation[]; } - /** - * 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 | null; - /** - * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} - */ - labels?: {[key: string]: string} | null; - /** - * The canonical id for this location. For example: `"us-east1"`. - */ - locationId?: string | null; - /** - * Service-specific metadata. For example the available capacity at the given location. - */ - metadata?: {[key: string]: any} | null; - /** - * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` - */ - name?: string | null; - } - /** - * BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses. - */ - export interface Schema$LocationMetadata { - /** - * The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations. - */ - legacyLocationId?: string | null; - } /** * The request for ReservationService.MoveAssignment. Note: "bigquery.reservationAssignments.create" permission is required on the destination_id. Note: "bigquery.reservationAssignments.create" and "bigquery.reservationAssignments.delete" permission is required on the related assignee. */ @@ -286,7 +239,7 @@ export namespace bigqueryreservation_v1beta1 { */ export interface Schema$Reservation { /** - * If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the maximum slot capacity as specified above. + * If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most. */ ignoreIdleSlots?: boolean | null; /** @@ -294,7 +247,7 @@ export namespace bigqueryreservation_v1beta1 { */ name?: string | null; /** - * Maximum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. In a scan of a multi-partitioned table, a single slot operates on a single partition of the table. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. + * Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceed the parent's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the parent's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. */ slotCapacity?: string | null; } @@ -352,76 +305,6 @@ export namespace bigqueryreservation_v1beta1 { ); } - /** - * bigqueryreservation.projects.locations.get - * @desc Gets information about a location. - * @alias bigqueryreservation.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://bigqueryreservation.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); - } - } - /** * bigqueryreservation.projects.locations.getBiReservation * @desc Retrieves a BI reservation. @@ -429,7 +312,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the requested reservation, for example: `projects/{project_id}/locations/{location_id}/bireservation` + * @param {string} params.name Required. Name of the requested reservation, for example: `projects/{project_id}/locations/{location_id}/bireservation` * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -496,86 +379,6 @@ export namespace bigqueryreservation_v1beta1 { } } - /** - * bigqueryreservation.projects.locations.list - * @desc Lists information about the supported locations for this service. - * @alias bigqueryreservation.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://bigqueryreservation.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}/locations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * bigqueryreservation.projects.locations.searchAssignments * @desc Looks up assignments for a specified resource for a particular region. If the request is about a project: 1) Assignments created on the project will be returned if they exist. 2) Otherwise assignments created on the closest ancestor will be returned. 3) Assignments for different JobTypes will all be returned. Same logic applies if the request is about a folder. If the request is about an organization, then assignments created on the organization will be returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior differences: 1) permission on the assignee will be verified in this API. 2) Hierarchy lookup (project->folder->organization) happens in this API. 3) Parent here is projects/x/locations/x, instead of projects/x/locations/xreservations/x. Note "-" cannot be used for projects nor locations. @@ -585,7 +388,7 @@ export namespace bigqueryreservation_v1beta1 { * @param {object} params Parameters for request * @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. - * @param {string} params.parent The resource name of the admin project(containing project and location), e.g.: "projects/myproject/locations/US". + * @param {string} params.parent Required. The resource name of the admin project(containing project and location), e.g.: "projects/myproject/locations/US". * @param {string=} params.query Please specify resource name as assignee in the query. e.g., "assignee=projects/myproject" "assignee=folders/123" "assignee=organizations/456" * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -738,18 +541,6 @@ export namespace bigqueryreservation_v1beta1 { } } - 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$Getbireservation extends StandardParameters { /** @@ -758,33 +549,9 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the requested reservation, for example: `projects/{project_id}/locations/{location_id}/bireservation` - */ - 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. + * Required. Name of the requested reservation, for example: `projects/{project_id}/locations/{location_id}/bireservation` */ name?: string; - /** - * The standard list page size. - */ - pageSize?: number; - /** - * The standard list page token. - */ - pageToken?: string; } export interface Params$Resource$Projects$Locations$Searchassignments extends StandardParameters { @@ -802,7 +569,7 @@ export namespace bigqueryreservation_v1beta1 { */ pageToken?: string; /** - * The resource name of the admin project(containing project and location), e.g.: "projects/myproject/locations/US". + * Required. The resource name of the admin project(containing project and location), e.g.: "projects/myproject/locations/US". */ parent?: string; /** @@ -846,7 +613,7 @@ export namespace bigqueryreservation_v1beta1 { * * @param {object} params Parameters for request * @param {boolean=} params.enforceSingleAdminProjectPerOrg If true, fail the request if another project in the organization has a capacity commitment. - * @param {string} params.parent Resource name of the parent reservation. E.g., projects/myproject/locations/US + * @param {string} params.parent Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US * @param {().CapacityCommitment} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -922,7 +689,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123 + * @param {string} params.name Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123 * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -992,7 +759,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the capacity commitment to retrieve. E.g., projects/myproject/locations/US/capacityCommitments/123 + * @param {string} params.name Required. Resource name of the capacity commitment to retrieve. E.g., projects/myproject/locations/US/capacityCommitments/123 * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1066,7 +833,7 @@ export namespace bigqueryreservation_v1beta1 { * @param {object} params Parameters for request * @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. - * @param {string} params.parent Resource name of the parent reservation. E.g., projects/myproject/locations/US + * @param {string} params.parent Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1156,7 +923,7 @@ export namespace bigqueryreservation_v1beta1 { */ enforceSingleAdminProjectPerOrg?: boolean; /** - * Resource name of the parent reservation. E.g., projects/myproject/locations/US + * Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US */ parent?: string; @@ -1173,7 +940,7 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123 + * Required. Resource name of the capacity commitment to delete. E.g., projects/myproject/locations/US/capacityCommitments/123 */ name?: string; } @@ -1185,7 +952,7 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the capacity commitment to retrieve. E.g., projects/myproject/locations/US/capacityCommitments/123 + * Required. Resource name of the capacity commitment to retrieve. E.g., projects/myproject/locations/US/capacityCommitments/123 */ name?: string; } @@ -1205,7 +972,7 @@ export namespace bigqueryreservation_v1beta1 { */ pageToken?: string; /** - * Resource name of the parent reservation. E.g., projects/myproject/locations/US + * Required. Resource name of the parent reservation. E.g., projects/myproject/locations/US */ parent?: string; } @@ -1227,8 +994,8 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Project, location. E.g., projects/myproject/locations/US - * @param {string=} params.reservationId The reservation ID. This field must only contain lower case alphanumeric characters or dash. + * @param {string} params.parent Required. Project, location. E.g., projects/myproject/locations/US + * @param {string=} params.reservationId The reservation ID. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. * @param {().Reservation} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1304,7 +1071,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + * @param {string} params.name Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1374,7 +1141,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + * @param {string} params.name Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1449,7 +1216,7 @@ export namespace bigqueryreservation_v1beta1 { * @param {string=} params.filter Can be used to filter out reservations based on names, capacity, etc, e.g.: filter="reservation.slot_capacity > 200" filter="reservation.name = \"*dev/x\"" Advanced filtering syntax can be [here](https://cloud.google.com/logging/docs/view/advanced-filters). * @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. - * @param {string} params.parent The parent resource name containing project and location, e.g.: "projects/myproject/locations/US" + * @param {string} params.parent Required. The parent resource name containing project and location, e.g.: "projects/myproject/locations/US" * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1602,11 +1369,11 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Project, location. E.g., projects/myproject/locations/US + * Required. Project, location. E.g., projects/myproject/locations/US */ parent?: string; /** - * The reservation ID. This field must only contain lower case alphanumeric characters or dash. + * The reservation ID. This field must only contain lower case alphanumeric characters or dash. Max length is 64 characters. */ reservationId?: string; @@ -1623,7 +1390,7 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + * Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod */ name?: string; } @@ -1635,7 +1402,7 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod + * Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod */ name?: string; } @@ -1659,7 +1426,7 @@ export namespace bigqueryreservation_v1beta1 { */ pageToken?: string; /** - * The parent resource name containing project and location, e.g.: "projects/myproject/locations/US" + * Required. The parent resource name containing project and location, e.g.: "projects/myproject/locations/US" */ parent?: string; } @@ -1698,7 +1465,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent resource name of the assignment E.g.: projects/myproject/locations/US/reservations/team1-prod + * @param {string} params.parent Required. The parent resource name of the assignment E.g.: projects/myproject/locations/US/reservations/team1-prod * @param {().Assignment} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1774,7 +1541,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Name of the resource, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * @param {string} params.name Required. Name of the resource, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1846,7 +1613,7 @@ export namespace bigqueryreservation_v1beta1 { * @param {object} params Parameters for request * @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. - * @param {string} params.parent The parent resource name e.g.: projects/myproject/locations/US/reservations/team1-prod Or: projects/myproject/locations/US/reservations/- + * @param {string} params.parent Required. The parent resource name e.g.: projects/myproject/locations/US/reservations/team1-prod Or: projects/myproject/locations/US/reservations/- * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1923,7 +1690,7 @@ export namespace bigqueryreservation_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The resource name of the assignment, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * @param {string} params.name Required. The resource name of the assignment, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 * @param {().MoveAssignmentRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2001,7 +1768,7 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent resource name of the assignment E.g.: projects/myproject/locations/US/reservations/team1-prod + * Required. The parent resource name of the assignment E.g.: projects/myproject/locations/US/reservations/team1-prod */ parent?: string; @@ -2018,7 +1785,7 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the resource, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * Required. Name of the resource, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 */ name?: string; } @@ -2038,7 +1805,7 @@ export namespace bigqueryreservation_v1beta1 { */ pageToken?: string; /** - * The parent resource name e.g.: projects/myproject/locations/US/reservations/team1-prod Or: projects/myproject/locations/US/reservations/- + * Required. The parent resource name e.g.: projects/myproject/locations/US/reservations/team1-prod Or: projects/myproject/locations/US/reservations/- */ parent?: string; } @@ -2050,7 +1817,7 @@ export namespace bigqueryreservation_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name of the assignment, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 + * Required. The resource name of the assignment, e.g.: projects/myproject/locations/US/reservations/team1-prod/assignments/123 */ name?: string; diff --git a/src/apis/bigtableadmin/v2.ts b/src/apis/bigtableadmin/v2.ts index c4be861e4b..d83ba67852 100644 --- a/src/apis/bigtableadmin/v2.ts +++ b/src/apis/bigtableadmin/v2.ts @@ -357,23 +357,23 @@ export namespace bigtableadmin_v2 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -2531,8 +2531,12 @@ export namespace bigtableadmin_v2 { export class Resource$Projects$Instances$Clusters { context: APIRequestContext; + backups: Resource$Projects$Instances$Clusters$Backups; constructor(context: APIRequestContext) { this.context = context; + this.backups = new Resource$Projects$Instances$Clusters$Backups( + this.context + ); } /** @@ -2983,6 +2987,196 @@ export namespace bigtableadmin_v2 { requestBody?: Schema$Cluster; } + export class Resource$Projects$Instances$Clusters$Backups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * bigtableadmin.projects.instances.clusters.backups.getIamPolicy + * @desc Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set. + * @alias bigtableadmin.projects.instances.clusters.backups.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.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getIamPolicy( + params?: Params$Resource$Projects$Instances$Clusters$Backups$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Instances$Clusters$Backups$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Instances$Clusters$Backups$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Clusters$Backups$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Clusters$Backups$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Clusters$Backups$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * bigtableadmin.projects.instances.clusters.backups.setIamPolicy + * @desc Sets the access control policy on a Table or Backup resource. Replaces any existing policy. + * @alias bigtableadmin.projects.instances.clusters.backups.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.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + setIamPolicy( + params?: Params$Resource$Projects$Instances$Clusters$Backups$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Instances$Clusters$Backups$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Instances$Clusters$Backups$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Clusters$Backups$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Clusters$Backups$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Clusters$Backups$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://bigtableadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Instances$Clusters$Backups$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GetIamPolicyRequest; + } + export interface Params$Resource$Projects$Instances$Clusters$Backups$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$Instances$Tables { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -3445,7 +3639,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.getIamPolicy - * @desc Gets the access control policy for a table resource. Returns an empty policy if an table exists but does not have a policy set. + * @desc Gets the access control policy for a Table or Backup resource. Returns an empty policy if the resource exists but does not have a policy set. * @alias bigtableadmin.projects.instances.tables.getIamPolicy * @memberOf! () * @@ -3671,7 +3865,7 @@ export namespace bigtableadmin_v2 { /** * bigtableadmin.projects.instances.tables.setIamPolicy - * @desc Sets the access control policy on a table resource. Replaces any existing policy. + * @desc Sets the access control policy on a Table or Backup resource. Replaces any existing policy. * @alias bigtableadmin.projects.instances.tables.setIamPolicy * @memberOf! () * diff --git a/src/apis/binaryauthorization/v1.ts b/src/apis/binaryauthorization/v1.ts index 881816c248..8794701453 100644 --- a/src/apis/binaryauthorization/v1.ts +++ b/src/apis/binaryauthorization/v1.ts @@ -205,23 +205,23 @@ export namespace binaryauthorization_v1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/binaryauthorization/v1beta1.ts b/src/apis/binaryauthorization/v1beta1.ts index 3ece0a249e..aa581c9e28 100644 --- a/src/apis/binaryauthorization/v1beta1.ts +++ b/src/apis/binaryauthorization/v1beta1.ts @@ -205,23 +205,23 @@ export namespace binaryauthorization_v1beta1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/books/v1.ts b/src/apis/books/v1.ts index 484b835ccd..2d1bcc9d58 100644 --- a/src/apis/books/v1.ts +++ b/src/apis/books/v1.ts @@ -363,6 +363,24 @@ export namespace books_v1 { */ kind?: string | null; } + export interface Schema$BooksSubscriptionReleaseInfo { + /** + * Amount in micros of the specified currency code. + */ + amountInMicros?: string | null; + /** + * Currency code of the amount. + */ + currencyCode?: string | null; + /** + * The release number of this issue/volume/book. + */ + releaseNumber?: string | null; + /** + * The release date. + */ + releaseTimestampUs?: string | null; + } export interface Schema$BooksVolumesRecommendedRateResponse { consistency_token?: string | null; } @@ -814,7 +832,14 @@ export namespace books_v1 { eligibleForSubscription?: boolean; imageUrl?: string; isComplete?: boolean; + seriesFormatType?: string; seriesId?: string; + seriesSubscriptionReleaseInfo?: { + cancellationTimestampUs?: string; + currentReleaseInfo?: Schema$BooksSubscriptionReleaseInfo; + nextReleaseInfo?: Schema$BooksSubscriptionReleaseInfo; + seriesSubscriptionType?: string; + }; seriesType?: string; subscriptionId?: string; title?: string; diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 75a1eada8d..f83c9cd911 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -290,7 +290,7 @@ export namespace chat_v1 { */ export interface Schema$Image { /** - * The aspect ratio of this image (width/height). + * The aspect ratio of this image (width/height). This field allows clients to reserve the right height for the image while waiting for it to load. It's not meant to override the native aspect ratio of the image. If unset, server will fill it by prefetching the image. */ aspectRatio?: number | null; /** @@ -542,6 +542,10 @@ export namespace chat_v1 { * The user's display name. */ displayName?: string | null; + /** + * Obfuscated domain information. + */ + domainId?: string | null; /** * Resource name, in the format "users/*". */ diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index ec21055f2d..34791f06ff 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -259,23 +259,23 @@ export namespace cloudasset_v1 { readTime?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -288,7 +288,7 @@ export namespace cloudasset_v1 { */ assetNames?: string[] | null; /** - * A list of types of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names and asset_types are exported to the feed. For example: "compute.googleapis.com/Disk" See [Introduction to Cloud Asset Inventory](https://cloud.google.com/resource-manager/docs/cloud-asset-inventory/overview) for all supported asset types. + * A list of types of the assets to receive updates. You must specify either or both of asset_names and asset_types. Only asset updates matching specified asset_names and asset_types are exported to the feed. For example: `"compute.googleapis.com/Disk"` See [this topic](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for a list of all supported asset types. */ assetTypes?: string[] | null; /** @@ -398,7 +398,7 @@ export namespace cloudasset_v1 { */ export interface Schema$GoogleCloudOrgpolicyV1RestoreDefault {} /** - * An `AccessLevel` is a label that can be applied to requests to GCP services, along with a list of requirements necessary for the label to be applied. + * An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied. */ export interface Schema$GoogleIdentityAccesscontextmanagerV1AccessLevel { /** @@ -409,6 +409,10 @@ export namespace cloudasset_v1 { * Output only. Time the `AccessLevel` was created in UTC. */ createTime?: string | null; + /** + * A `CustomLevel` written in the Common Expression Language. + */ + custom?: Schema$GoogleIdentityAccesscontextmanagerV1CustomLevel; /** * Description of the `AccessLevel` and its use. Does not affect behavior. */ @@ -427,7 +431,7 @@ export namespace cloudasset_v1 { updateTime?: string | null; } /** - * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use GCP services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. + * `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. */ export interface Schema$GoogleIdentityAccesscontextmanagerV1AccessPolicy { /** @@ -493,6 +497,15 @@ export namespace cloudasset_v1 { */ requiredAccessLevels?: string[] | null; } + /** + * `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec + */ + export interface Schema$GoogleIdentityAccesscontextmanagerV1CustomLevel { + /** + * Required. A Cloud CEL expression evaluating to a boolean. + */ + expr?: Schema$Expr; + } /** * `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. */ @@ -540,7 +553,7 @@ export namespace cloudasset_v1 { requireVerifiedChromeOs?: boolean | null; } /** - * `ServicePerimeter` describes a set of GCP resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only GCP projects as members, a single GCP project may belong to multiple Service Perimeter Bridges. + * `ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges. */ export interface Schema$GoogleIdentityAccesscontextmanagerV1ServicePerimeter { /** @@ -559,6 +572,10 @@ export namespace cloudasset_v1 { * Perimeter type indicator. A single project is allowed to be a member of single regular perimeter, but multiple service perimeter bridges. A project cannot be a included in a perimeter bridge without being included in regular perimeter. For perimeter bridges, the restricted service list as well as access level lists must be empty. */ perimeterType?: string | null; + /** + * Proposed (or dry run) ServicePerimeter configuration. This configuration allows to specify and test ServicePerimeter configuration without enforcing actual access restrictions. Only allowed to be set when the "use_explicit_dry_run_spec" flag is set. + */ + spec?: Schema$GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig; /** * Current ServicePerimeter configuration. Specifies sets of resources, restricted services and access levels that determine perimeter content and boundaries. */ @@ -571,23 +588,44 @@ export namespace cloudasset_v1 { * Output only. Time the `ServicePerimeter` was updated in UTC. */ updateTime?: string | null; + /** + * Use explicit dry run spec flag. Ordinarily, a dry-run spec implicitly exists for all Service Perimeters, and that spec is identical to the status for those Service Perimeters. When this flag is set, it inhibits the generation of the implicit spec, thereby allowing the user to explicitly provide a configuration ("spec") to use in a dry-run version of the Service Perimeter. This allows the user to test changes to the enforced config ("status") without actually enforcing them. This testing is done through analyzing the differences between currently enforced and suggested restrictions. use_explicit_dry_run_spec must bet set to True if any of the fields in the spec are set to non-default values. + */ + useExplicitDryRunSpec?: boolean | null; } /** - * `ServicePerimeterConfig` specifies a set of GCP resources that describe specific Service Perimeter configuration. + * `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. */ export interface Schema$GoogleIdentityAccesscontextmanagerV1ServicePerimeterConfig { /** - * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. + * A list of `AccessLevel` resource names that allow resources within the `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed must be in the same policy as this `ServicePerimeter`. Referencing a nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are listed, resources within the perimeter can only be accessed via Google Cloud calls with request origins within the perimeter. Example: `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`. For Service Perimeter Bridge, must be empty. */ accessLevels?: string[] | null; /** - * A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` + * A list of Google Cloud resources that are inside of the service perimeter. Currently only projects are allowed. Format: `projects/{project_number}` */ resources?: string[] | null; /** - * GCP services that are subject to the Service Perimeter restrictions. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. + * Google Cloud services that are subject to the Service Perimeter restrictions. For example, if `storage.googleapis.com` is specified, access to the storage buckets inside the perimeter must meet the perimeter's access restrictions. */ restrictedServices?: string[] | null; + /** + * Configuration for within Perimeter allowed APIs. + */ + vpcAccessibleServices?: Schema$GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices; + } + /** + * Specifies how APIs are allowed to communicate within the Service Perimeter. + */ + export interface Schema$GoogleIdentityAccesscontextmanagerV1VpcAccessibleServices { + /** + * The list of APIs usable within the Service Perimeter. Must be empty unless 'enable_restriction' is True. + */ + allowedServices?: string[] | null; + /** + * Whether to restrict API calls within the Service Perimeter to the list of APIs specified in 'allowed_services'. + */ + enableRestriction?: boolean | null; } export interface Schema$ListFeedsResponse { /** diff --git a/src/apis/cloudasset/v1beta1.ts b/src/apis/cloudasset/v1beta1.ts index 36bbd22332..162064b658 100644 --- a/src/apis/cloudasset/v1beta1.ts +++ b/src/apis/cloudasset/v1beta1.ts @@ -214,23 +214,23 @@ export namespace cloudasset_v1beta1 { readTime?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudbilling/v1.ts b/src/apis/cloudbilling/v1.ts index ecd62cc491..63455e2fde 100644 --- a/src/apis/cloudbilling/v1.ts +++ b/src/apis/cloudbilling/v1.ts @@ -216,23 +216,23 @@ export namespace cloudbilling_v1 { usageType?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudbuild/index.ts b/src/apis/cloudbuild/index.ts index 05f25a401b..268965a38c 100644 --- a/src/apis/cloudbuild/index.ts +++ b/src/apis/cloudbuild/index.ts @@ -16,10 +16,12 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {cloudbuild_v1} from './v1'; import {cloudbuild_v1alpha1} from './v1alpha1'; +import {cloudbuild_v1alpha2} from './v1alpha2'; export const VERSIONS = { v1: cloudbuild_v1.Cloudbuild, v1alpha1: cloudbuild_v1alpha1.Cloudbuild, + v1alpha2: cloudbuild_v1alpha2.Cloudbuild, }; export function cloudbuild(version: 'v1'): cloudbuild_v1.Cloudbuild; @@ -30,8 +32,15 @@ export function cloudbuild(version: 'v1alpha1'): cloudbuild_v1alpha1.Cloudbuild; export function cloudbuild( options: cloudbuild_v1alpha1.Options ): cloudbuild_v1alpha1.Cloudbuild; +export function cloudbuild(version: 'v1alpha2'): cloudbuild_v1alpha2.Cloudbuild; +export function cloudbuild( + options: cloudbuild_v1alpha2.Options +): cloudbuild_v1alpha2.Cloudbuild; export function cloudbuild< - T = cloudbuild_v1.Cloudbuild | cloudbuild_v1alpha1.Cloudbuild + T = + | cloudbuild_v1.Cloudbuild + | cloudbuild_v1alpha1.Cloudbuild + | cloudbuild_v1alpha2.Cloudbuild >( this: GoogleConfigurable, versionOrOptions: @@ -39,6 +48,8 @@ export function cloudbuild< | cloudbuild_v1.Options | 'v1alpha1' | cloudbuild_v1alpha1.Options + | 'v1alpha2' + | cloudbuild_v1alpha2.Options ) { return getAPI('cloudbuild', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index afd3fc5363..f484bf0a2a 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -401,7 +401,7 @@ export namespace cloudbuild_v1 { */ id?: string | null; /** - * ignored_files and included_files are file glob matches using http://godoc/pkg/path/filepath#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. + * ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. */ ignoredFiles?: string[] | null; /** diff --git a/src/apis/cloudbuild/v1alpha2.ts b/src/apis/cloudbuild/v1alpha2.ts new file mode 100644 index 0000000000..176af90f6c --- /dev/null +++ b/src/apis/cloudbuild/v1alpha2.ts @@ -0,0 +1,1088 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace cloudbuild_v1alpha2 { + export interface Options extends GlobalOptions { + version: 'v1alpha2'; + } + + 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 Build API + * + * Creates and manages builds on Google Cloud Platform. + * + * @example + * const {google} = require('googleapis'); + * const cloudbuild = google.cloudbuild('v1alpha2'); + * + * @namespace cloudbuild + * @type {Function} + * @version v1alpha2 + * @variation v1alpha2 + * @param {object=} options Options for Cloudbuild + */ + export class Cloudbuild { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Files in the workspace to upload to Cloud Storage upon successful completion of all build steps. + */ + export interface Schema$ArtifactObjects { + /** + * Cloud Storage bucket and optional object path, in the form "gs://bucket/path/to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Files in the workspace matching any path pattern will be uploaded to Cloud Storage with this location as a prefix. + */ + location?: string | null; + /** + * Path globs used to match files in the build's workspace. + */ + paths?: string[] | null; + /** + * Output only. Stores timing information for pushing all artifact objects. + */ + timing?: Schema$TimeSpan; + } + /** + * An artifact that was uploaded during a build. This is a single record in the artifact manifest JSON file. + */ + export interface Schema$ArtifactResult { + /** + * The file hash of the artifact. + */ + fileHash?: Schema$FileHashes[]; + /** + * The path of an artifact in a Google Cloud Storage bucket, with the generation number. For example, `gs://mybucket/path/to/output.jar#generation`. + */ + location?: string | null; + } + /** + * Artifacts produced by a build that should be uploaded upon successful completion of all build steps. + */ + export interface Schema$Artifacts { + /** + * A list of images to be pushed upon the successful completion of all build steps. The images will be pushed using the builder service account's credentials. The digests of the pushed images will be stored in the Build resource's results field. If any of the images fail to be pushed, the build is marked FAILURE. + */ + images?: string[] | null; + /** + * A list of objects to be uploaded to Cloud Storage upon successful completion of all build steps. Files in the workspace matching specified paths globs will be uploaded to the specified Cloud Storage location using the builder service account's credentials. The location and generation of the uploaded objects will be stored in the Build resource's results field. If any objects fail to be pushed, the build is marked FAILURE. + */ + objects?: Schema$ArtifactObjects; + } + /** + * A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. + */ + export interface Schema$Build { + /** + * Artifacts produced by the build that should be uploaded upon successful completion of all build steps. + */ + artifacts?: Schema$Artifacts; + /** + * Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. + */ + buildTriggerId?: string | null; + /** + * Output only. Time at which the request to create the build was received. + */ + createTime?: string | null; + /** + * Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. + */ + finishTime?: string | null; + /** + * Output only. Unique identifier of the build. + */ + id?: string | null; + /** + * A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. + */ + images?: string[] | null; + /** + * Google Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. + */ + logsBucket?: string | null; + /** + * Output only. URL to logs for this build in Google Cloud Console. + */ + logUrl?: string | null; + /** + * Special options for this build. + */ + options?: Schema$BuildOptions; + /** + * Output only. ID of the project. + */ + projectId?: string | null; + /** + * Output only. Results of the build. + */ + results?: Schema$Results; + /** + * Secrets to decrypt using Cloud Key Management Service. + */ + secrets?: Schema$Secret[]; + /** + * The location of the source files to build. + */ + source?: Schema$Source; + /** + * Output only. A permanent fixed identifier for source. + */ + sourceProvenance?: Schema$SourceProvenance; + /** + * Output only. Time at which execution of the build was started. + */ + startTime?: string | null; + /** + * Output only. Status of the build. + */ + status?: string | null; + /** + * Output only. Customer-readable message about the current status. + */ + statusDetail?: string | null; + /** + * Required. The operations to be performed on the workspace. + */ + steps?: Schema$BuildStep[]; + /** + * Substitutions data for `Build` resource. + */ + substitutions?: {[key: string]: string} | null; + /** + * Tags for annotation of a `Build`. These are not docker tags. + */ + tags?: string[] | null; + /** + * Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. Default time is ten minutes. + */ + timeout?: string | null; + /** + * Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps * PUSH: time to push all specified images. * FETCHSOURCE: time to fetch source. If the build does not specify source or images, these keys will not be included. + */ + timing?: {[key: string]: Schema$TimeSpan} | null; + } + /** + * Metadata for build operations. + */ + export interface Schema$BuildOperationMetadata { + /** + * The build that the operation is tracking. + */ + build?: Schema$Build; + } + /** + * Optional arguments to enable specific features of builds. + */ + export interface Schema$BuildOptions { + /** + * Requested disk size for the VM that runs the build. Note that this is *NOT* "disk free"; some of the space will be used by the operating system and build utilities. Also note that this is the minimum disk size that will be allocated for the build -- the build may run with a larger disk than requested. At present, the maximum disk size is 1000GB; builds that request more than the maximum are rejected with an error. + */ + diskSizeGb?: string | null; + /** + * A list of global environment variable definitions that will exist for all build steps in this build. If a variable is defined in both globally and in a build step, the variable will use the build step value. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + */ + env?: string[] | null; + /** + * Option to specify the logging mode, which determines where the logs are stored. + */ + logging?: string | null; + /** + * Option to define build log streaming behavior to Google Cloud Storage. + */ + logStreamingOption?: string | null; + /** + * Compute Engine machine type on which to run the build. + */ + machineType?: string | null; + /** + * Requested verifiability options. + */ + requestedVerifyOption?: string | null; + /** + * A list of global environment variables, which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. These variables will be available to all build steps in this build. + */ + secretEnv?: string[] | null; + /** + * Requested hash for SourceProvenance. + */ + sourceProvenanceHash?: string[] | null; + /** + * Option to specify behavior when there is an error in the substitution checks. + */ + substitutionOption?: string | null; + /** + * Global list of volumes to mount for ALL build steps Each volume is created as an empty volume prior to starting the build process. Upon completion of the build, volumes and their contents are discarded. Global volume names and paths cannot conflict with the volumes defined a build step. Using a global volume in a build with only one step is not valid as it is indicative of a build request with an incorrect configuration. + */ + volumes?: Schema$Volume[]; + /** + * Option to specify a `WorkerPool` for the build. Format: projects/{project}/workerPools/{workerPool} This field is experimental. + */ + workerPool?: string | null; + } + /** + * A step in the build pipeline. + */ + export interface Schema$BuildStep { + /** + * A list of arguments that will be presented to the step when it is started. If the image used to run the step's container has an entrypoint, the `args` are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments. + */ + args?: string[] | null; + /** + * Working directory to use when running this step's container. If this value is a relative path, it is relative to the build's working directory. If this value is absolute, it may be outside the build's working directory, in which case the contents of the path may not be persisted across build step executions, unless a `volume` for that path is specified. If the build specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies an absolute path, the `RepoSource` `dir` is ignored for the step's execution. + */ + dir?: string | null; + /** + * Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used. + */ + entrypoint?: string | null; + /** + * A list of environment variable definitions to be used when running a step. The elements are of the form "KEY=VALUE" for the environment variable "KEY" being given the value "VALUE". + */ + env?: string[] | null; + /** + * Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency. + */ + id?: string | null; + /** + * Required. The name of the container image that will run this particular build step. If the image is available in the host's Docker daemon's cache, it will be run directly. If not, the host will attempt to pull the image first, using the builder service account's credentials if necessary. The Docker daemon's cache will already have the latest versions of all of the officially supported build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also have cached many of the layers for some popular images, like "ubuntu", "debian", but they will be refreshed at the time you attempt to use them. If you built an image in a previous build step, it will be stored in the host's Docker daemon's cache and is available to use as the name for a later build step. + */ + name?: string | null; + /** + * Output only. Stores timing information for pulling this build step's builder image only. + */ + pullTiming?: Schema$TimeSpan; + /** + * A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build's `Secret`. + */ + secretEnv?: string[] | null; + /** + * Output only. Status of the build step. At this time, build step status is only updated on build completion; step status is not updated in real-time as the build progresses. + */ + status?: string | null; + /** + * Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out. + */ + timeout?: string | null; + /** + * Output only. Stores timing information for executing this build step. + */ + timing?: Schema$TimeSpan; + /** + * List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. + */ + volumes?: Schema$Volume[]; + /** + * The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in `wait_for` have completed successfully. If `wait_for` is empty, this build step will start when all previous build steps in the `Build.Steps` list have completed successfully. + */ + waitFor?: string[] | null; + } + /** + * An image built by the pipeline. + */ + export interface Schema$BuiltImage { + /** + * Docker Registry 2.0 digest. + */ + digest?: string | null; + /** + * Name used to push the container image to Google Container Registry, as presented to `docker push`. + */ + name?: string | null; + /** + * Output only. Stores timing information for pushing the specified image. + */ + pushTiming?: Schema$TimeSpan; + } + /** + * 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 {} + /** + * Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build. + */ + export interface Schema$FileHashes { + /** + * Collection of file hashes. + */ + fileHash?: Schema$Hash[]; + } + /** + * Container message for hash values. + */ + export interface Schema$Hash { + /** + * The type of hash that was performed. + */ + type?: string | null; + /** + * The hash value. + */ + value?: string | null; + } + /** + * Response containing existing `WorkerPools`. + */ + export interface Schema$ListWorkerPoolsResponse { + /** + * `WorkerPools` for the specified project. + */ + workerPools?: Schema$WorkerPool[]; + } + /** + * Network describes the network configuration for a `WorkerPool`. + */ + export interface Schema$NetworkConfig { + /** + * Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to WorkerPool.project_id on the default network. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number, such as `12345`, and {network} is the name of a VPC network in the project. + */ + peeredNetwork?: string | null; + } + /** + * Location of the source in a Google Cloud Source Repository. + */ + export interface Schema$RepoSource { + /** + * Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + */ + branchName?: string | null; + /** + * Explicit commit SHA to build. + */ + commitSha?: string | null; + /** + * Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. + */ + dir?: string | null; + /** + * ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed. + */ + projectId?: string | null; + /** + * Required. Name of the Cloud Source Repository. + */ + repoName?: string | null; + /** + * Substitutions to use in a triggered build. Should only be used with RunBuildTrigger + */ + substitutions?: {[key: string]: string} | null; + /** + * Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax + */ + tagName?: string | null; + } + /** + * Artifacts created by the build pipeline. + */ + export interface Schema$Results { + /** + * Path to the artifact manifest. Only populated when artifacts are uploaded. + */ + artifactManifest?: string | null; + /** + * Time to push all non-container artifacts. + */ + artifactTiming?: Schema$TimeSpan; + /** + * List of build step digests, in the order corresponding to build step indices. + */ + buildStepImages?: string[] | null; + /** + * List of build step outputs, produced by builder images, in the order corresponding to build step indices. [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders) can produce this output by writing to `$BUILDER_OUTPUT/output`. Only the first 4KB of data is stored. + */ + buildStepOutputs?: string[] | null; + /** + * Container images that were built as a part of the build. + */ + images?: Schema$BuiltImage[]; + /** + * Number of artifacts uploaded. Only populated when artifacts are uploaded. + */ + numArtifacts?: string | null; + } + /** + * Pairs a set of secret environment variables containing encrypted values with the Cloud KMS key to use to decrypt the value. + */ + export interface Schema$Secret { + /** + * Cloud KMS key name to use to decrypt these envs. + */ + kmsKeyName?: string | null; + /** + * Map of environment variable name to its encrypted value. Secret environment variables must be unique across all of a build's secrets, and must be used by at least one build step. Values can be at most 64 KB in size. There can be at most 100 secret values across all of a build's secrets. + */ + secretEnv?: {[key: string]: string} | null; + } + /** + * Location of the source in a supported storage service. + */ + export interface Schema$Source { + /** + * If provided, get the source from this location in a Cloud Source Repository. + */ + repoSource?: Schema$RepoSource; + /** + * If provided, get the source from this location in Google Cloud Storage. + */ + storageSource?: Schema$StorageSource; + } + /** + * Provenance of the source. Ways to find the original source, or verify that some source was used for this build. + */ + export interface Schema$SourceProvenance { + /** + * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. + */ + fileHashes?: {[key: string]: Schema$FileHashes} | null; + /** + * A copy of the build's `source.repo_source`, if exists, with any revisions resolved. + */ + resolvedRepoSource?: Schema$RepoSource; + /** + * A copy of the build's `source.storage_source`, if exists, with any generations resolved. + */ + resolvedStorageSource?: Schema$StorageSource; + } + /** + * Location of the source in an archive file in Google Cloud Storage. + */ + export interface Schema$StorageSource { + /** + * Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). + */ + bucket?: string | null; + /** + * Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used. + */ + generation?: string | null; + /** + * Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build. + */ + object?: string | null; + } + /** + * Start and end times for a build execution phase. + */ + export interface Schema$TimeSpan { + /** + * End of time span. + */ + endTime?: string | null; + /** + * Start of time span. + */ + startTime?: string | null; + } + /** + * Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. + */ + export interface Schema$Volume { + /** + * Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps. + */ + name?: string | null; + /** + * Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths. + */ + path?: string | null; + } + /** + * WorkerConfig defines the configuration to be used for a creating workers in the pool. + */ + export interface Schema$WorkerConfig { + /** + * Size of the disk attached to the worker, in GB. See https://cloud.google.com/compute/docs/disks/ If `0` is specified, Cloud Build will use a standard disk size. + */ + diskSizeGb?: string | null; + /** + * Machine Type of the worker, such as n1-standard-1. See https://cloud.google.com/compute/docs/machine-types. If left blank, Cloud Build will use a standard unspecified machine to create the worker pool. + */ + machineType?: string | null; + } + /** + * Configuration for a WorkerPool to run the builds. Workers are machines that Cloud Build uses to run your builds. By default, all workers run in a project owned by Cloud Build. To have full control over the workers that execute your builds -- such as enabling them to access private resources on your private network -- you can request Cloud Build to run the workers in your own project by creating a custom workers pool. + */ + export interface Schema$WorkerPool { + /** + * Output only. Time at which the request to create the `WorkerPool` was received. + */ + createTime?: string | null; + /** + * Output only. Time at which the request to delete the `WorkerPool` was received. + */ + deleteTime?: string | null; + /** + * Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. + */ + name?: string | null; + /** + * Network configuration for the `WorkerPool`. + */ + networkConfig?: Schema$NetworkConfig; + /** + * Required. Immutable. The region where the `WorkerPool` runs. Only "us-central1" is currently supported. Note that `region` cannot be changed once the `WorkerPool` is created. + */ + region?: string | null; + /** + * Output only. WorkerPool state. + */ + state?: string | null; + /** + * Output only. Time at which the request to update the `WorkerPool` was received. + */ + updateTime?: string | null; + /** + * Worker configuration for the `WorkerPool`. + */ + workerConfig?: Schema$WorkerConfig; + } + + export class Resource$Projects { + context: APIRequestContext; + workerPools: Resource$Projects$Workerpools; + constructor(context: APIRequestContext) { + this.context = context; + this.workerPools = new Resource$Projects$Workerpools(this.context); + } + } + + export class Resource$Projects$Workerpools { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * cloudbuild.projects.workerPools.create + * @desc Creates a `WorkerPool` to run the builds, and returns the new worker pool. + * @alias cloudbuild.projects.workerPools.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent resource where this book will be created. Format: projects/{project} + * @param {string=} params.workerPoolId Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. + * @param {().WorkerPool} params.requestBody Request 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$Workerpools$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Workerpools$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Workerpools$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Workerpools$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Workerpools$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Workerpools$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha2/{+parent}/workerPools').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudbuild.projects.workerPools.delete + * @desc Deletes a `WorkerPool`. + * @alias cloudbuild.projects.workerPools.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the `WorkerPool` to delete. Format: projects/{project}/workerPools/{workerPool} + * @param {object} [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$Workerpools$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Workerpools$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Workerpools$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Workerpools$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Workerpools$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Workerpools$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudbuild.projects.workerPools.get + * @desc Returns details of a `WorkerPool`. + * @alias cloudbuild.projects.workerPools.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the `WorkerPool` to retrieve. Format: projects/{project}/workerPools/{workerPool} + * @param {object} [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$Workerpools$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Workerpools$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Workerpools$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Workerpools$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Workerpools$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Workerpools$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudbuild.projects.workerPools.list + * @desc Lists `WorkerPool`s by project. + * @alias cloudbuild.projects.workerPools.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent, which owns this collection of `WorkerPools`. Format: projects/{project} + * @param {object} [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$Workerpools$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Workerpools$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Workerpools$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Workerpools$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Workerpools$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Workerpools$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha2/{+parent}/workerPools').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudbuild.projects.workerPools.patch + * @desc Updates a `WorkerPool`. + * @alias cloudbuild.projects.workerPools.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. + * @param {string=} params.updateMask A mask specifying which fields in `WorkerPool` should be updated. + * @param {().WorkerPool} params.requestBody Request 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$Workerpools$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Workerpools$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Workerpools$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Workerpools$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Workerpools$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Workerpools$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudbuild.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha2/{+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$Workerpools$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent resource where this book will be created. Format: projects/{project} + */ + parent?: string; + /** + * Required. Immutable. The ID to use for the `WorkerPool`, which will become the final component of the resource name. This value should be 1-63 characters, and valid characters are /a-z-/. + */ + workerPoolId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkerPool; + } + export interface Params$Resource$Projects$Workerpools$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the `WorkerPool` to delete. Format: projects/{project}/workerPools/{workerPool} + */ + name?: string; + } + export interface Params$Resource$Projects$Workerpools$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the `WorkerPool` to retrieve. Format: projects/{project}/workerPools/{workerPool} + */ + name?: string; + } + export interface Params$Resource$Projects$Workerpools$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent, which owns this collection of `WorkerPools`. Format: projects/{project} + */ + parent?: string; + } + export interface Params$Resource$Projects$Workerpools$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource name of the `WorkerPool`. Format of the name is `projects/{project_id}/workerPools/{worker_pool_id}`, where the value of {worker_pool_id} is provided in the CreateWorkerPool request. + */ + name?: string; + /** + * A mask specifying which fields in `WorkerPool` should be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WorkerPool; + } +} diff --git a/src/apis/clouderrorreporting/v1beta1.ts b/src/apis/clouderrorreporting/v1beta1.ts index a07f9d0a05..664577c8c1 100644 --- a/src/apis/clouderrorreporting/v1beta1.ts +++ b/src/apis/clouderrorreporting/v1beta1.ts @@ -170,7 +170,7 @@ export namespace clouderrorreporting_v1beta1 { */ groupId?: string | null; /** - * The group resource name. Example: <code>projects/my-project-123/groups/my-groupid</code> + * The group resource name. Example: <code>projects/my-project-123/groups/CNSgkpnppqKCUw</code> */ name?: string | null; /** @@ -801,7 +801,7 @@ export namespace clouderrorreporting_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The group resource name. Example: projects/my-project-123/groups/my-groupid + * @param {string} params.name The group resource name. Example: projects/my-project-123/groups/CNSgkpnppqKCUw * @param {().ErrorGroup} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -888,7 +888,7 @@ export namespace clouderrorreporting_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The group resource name. Example: projects/my-project-123/groups/my-groupid + * The group resource name. Example: projects/my-project-123/groups/CNSgkpnppqKCUw */ name?: string; diff --git a/src/apis/cloudfunctions/v1.ts b/src/apis/cloudfunctions/v1.ts index 1092df785e..dcc848ca46 100644 --- a/src/apis/cloudfunctions/v1.ts +++ b/src/apis/cloudfunctions/v1.ts @@ -152,7 +152,7 @@ export namespace cloudfunctions_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -214,6 +214,10 @@ export namespace cloudfunctions_v1 { * An HTTPS endpoint type of source that can be triggered via URL. */ httpsTrigger?: Schema$HttpsTrigger; + /** + * The ingress settings for the function, controlling what traffic can reach it. + */ + ingressSettings?: string | null; /** * Labels associated with this Cloud Function. */ @@ -270,6 +274,10 @@ export namespace cloudfunctions_v1 { * The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is `projects/x/locations/x/connectors/x This field is mutually exclusive with `network` field and will eventually replace it. See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. */ vpcConnector?: string | null; + /** + * The egress settings for the connector, controlling what traffic is diverted through it. + */ + vpcConnectorEgressSettings?: string | null; } /** * Describes EventTrigger, used to request events be sent from another service. @@ -293,23 +301,23 @@ export namespace cloudfunctions_v1 { service?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -506,7 +514,7 @@ export namespace cloudfunctions_v1 { versionId?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -514,15 +522,15 @@ export namespace cloudfunctions_v1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ 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. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if the incoming policy version does not meet the requirements for modifying the stored policy. + * `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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a binding (conditional or unconditional) from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, version compliance checks against the stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } diff --git a/src/apis/cloudidentity/v1.ts b/src/apis/cloudidentity/v1.ts index 33b1438aec..2ce1c8c35c 100644 --- a/src/apis/cloudidentity/v1.ts +++ b/src/apis/cloudidentity/v1.ts @@ -115,6 +115,254 @@ export namespace cloudidentity_v1 { } } + /** + * Resource representing the Android specific attributes of a Device. + */ + export interface Schema$AndroidAttributes { + /** + * Baseband version of Android device. + */ + basebandVersion?: string | null; + /** + * Device bootloader version. Example: 0.6.7. + */ + bootloaderVersion?: string | null; + /** + * Build number of Android device. + */ + buildNumber?: string | null; + /** + * Whether developer options is enabled on device. + */ + enabledDeveloperOptions?: boolean | null; + /** + * Whether applications from unknown sources can be installed on device. + */ + enabledUnknownSources?: boolean | null; + /** + * Whether adb (USB debugging) is enabled on device. + */ + enabledUsbDebugging?: boolean | null; + /** + * Device encryption state. + */ + encryptionState?: string | null; + /** + * Device hardware. Example: Sprout. + */ + hardware?: string | null; + /** + * Kernel version of Android device. + */ + kernelVersion?: string | null; + /** + * Domain name for Google accounts on device. Type for other accounts on device. Will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com". + */ + otherAccounts?: string[] | null; + /** + * Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles. + */ + ownerProfileAccount?: boolean | null; + /** + * Ownership privileges on device. + */ + ownershipPrivilege?: string | null; + /** + * OS security patch update time on device. + */ + securityPatchTime?: string | null; + /** + * Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy. + */ + supportsWorkProfile?: boolean | null; + } + /** + * Response message for approving the device to access user data. + */ + export interface Schema$ApproveDeviceUserResponse { + /** + * Resultant DeviceUser object for the action. + */ + deviceUser?: Schema$DeviceUser; + } + /** + * Response message for blocking the device from accessing user data. + */ + export interface Schema$BlockDeviceUserResponse { + /** + * Resultant DeviceUser object for the action. + */ + deviceUser?: Schema$DeviceUser; + } + /** + * Response message for cancelling an unfinished device wipe. + */ + export interface Schema$CancelWipeDeviceResponse { + /** + * Resultant Device object for the action. Note that asset tags will not be returned in the device object. + */ + device?: Schema$Device; + } + /** + * Response message for cancelling an unfinished user account wipe. + */ + export interface Schema$CancelWipeDeviceUserResponse { + /** + * Resultant DeviceUser object for the action. + */ + deviceUser?: Schema$DeviceUser; + } + /** + * Represents a Device known to Google Cloud, independent of the device ownership, type, and whether it is assigned or in use by a user. + */ + export interface Schema$Device { + /** + * Output only. Attributes specific to Android devices. + */ + androidSpecificAttributes?: Schema$AndroidAttributes; + /** + * Asset tag of the device. + */ + assetTag?: string | null; + /** + * Output only. Device brand. Example: Samsung. + */ + brand?: string | null; + /** + * Output only. Represents whether the Device is compromised. + */ + compromisedState?: string | null; + /** + * Output only. When the Company-Owned device was imported. This field is empty for BYOD devices. + */ + createTime?: string | null; + /** + * Output only. Type of device. + */ + deviceType?: string | null; + /** + * Output only. IMEI number of device if GSM device; empty otherwise. + */ + imei?: string | null; + /** + * Most recent time when device synced with this service. + */ + lastSyncTime?: string | null; + /** + * Output only. Management state of the device + */ + managementState?: string | null; + /** + * Output only. Device manufacturer. Example: Motorola. + */ + manufacturer?: string | null; + /** + * Output only. MEID number of device if CDMA device; empty otherwise. + */ + meid?: string | null; + /** + * Output only. Model name of device. Example: Pixel 3. + */ + model?: string | null; + /** + * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}`, where device_id is the unique id assigned to the Device. + */ + name?: string | null; + /** + * Output only. Mobile or network operator of device, if available. + */ + networkOperator?: string | null; + /** + * Output only. OS version of the device. Example: Android 8.1.0. + */ + osVersion?: string | null; + /** + * Whether the device is owned by the company or an individual + */ + ownerType?: string | null; + /** + * Output only. OS release version. Example: 6.0. + */ + releaseVersion?: string | null; + /** + * Serial Number of device. Example: HT82V1A01076. + */ + serialNumber?: string | null; + /** + * WiFi MAC addresses of device. + */ + wifiMacAddresses?: string[] | null; + } + /** + * A DeviceUser is a resource representing a user's use of a Device + */ + export interface Schema$DeviceUser { + /** + * Compromised State of the DeviceUser object + */ + compromisedState?: string | null; + /** + * Output only. Most recent time when user registered with this service. + */ + firstSyncTime?: string | null; + /** + * Output only. Default locale used on device, in IETF BCP-47 format. + */ + languageCode?: string | null; + /** + * Output only. Last time when user synced with policies. + */ + lastSyncTime?: string | null; + /** + * Output only. Management state of the user on the device. + */ + managementState?: string | null; + /** + * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{user_id}`, where user_id is the ID of the user associated with the user session. + */ + name?: string | null; + /** + * Password state of the DeviceUser object + */ + passwordState?: string | null; + /** + * Output only. User agent on the device for this specific user + */ + userAgent?: string | null; + /** + * Email address of the user registered on the device. + */ + userEmail?: string | null; + } + /** + * An EndpointApp represents an app that is installed on a device Next ID to use: 7 + */ + export interface Schema$EndpointApp { + /** + * Output only. Name of the app displayed to the user + */ + displayName?: string | null; + /** + * Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the EndpointApp in format: `devices/{device}/deviceUsers/{device_user}/endpointApps/{endpoint_app}`, where client_app_id is the ID of the app associated with the Device. + */ + name?: string | null; + /** + * Output only. Full package name of the installed app + */ + packageName?: string | null; + /** + * Output only. Names of all permissions granted to the installed app + */ + permissions?: string[] | null; + /** + * Output only. Version code of the installed app + */ + versionCode?: number | null; + /** + * Output only. Version name of the installed app + */ + versionName?: string | null; + } /** * An EntityKey uniquely identifies an Entity. Namespaces are used to provide isolation for IDs. A single ID can be reused across namespaces but the combination of a namespace and an ID must be unique. */ @@ -165,6 +413,45 @@ export namespace cloudidentity_v1 { */ updateTime?: string | null; } + /** + * Response message that is returned in LRO result of ListDevices Operation. + */ + export interface Schema$ListDevicesResponse { + /** + * Devices meeting the list restrictions. + */ + devices?: Schema$Device[]; + /** + * Token to retrieve the next page of results. Empty if there are no more results. + */ + nextPageToken?: string | null; + } + /** + * Response message that is returned in LRO result of ListDeviceUsers Operation. + */ + export interface Schema$ListDeviceUsersResponse { + /** + * Devices meeting the list restrictions. + */ + deviceUsers?: Schema$DeviceUser[]; + /** + * Token to retrieve the next page of results. Empty if there are no more results. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing all apps on the device. + */ + export interface Schema$ListEndpointAppsResponse { + /** + * The list of matching EndpointApps found as a result of the request. + */ + endpointApps?: Schema$EndpointApp[]; + /** + * Token to retrieve the next page of results. Empty if there are no more results. + */ + nextPageToken?: string | null; + } /** * Response message for ListGroups operation. */ @@ -286,6 +573,24 @@ export namespace cloudidentity_v1 { */ message?: string | null; } + /** + * Response message for wiping all data on the device. + */ + export interface Schema$WipeDeviceResponse { + /** + * Resultant Device object for the action. Note that asset tags will not be returned in the device object. + */ + device?: Schema$Device; + } + /** + * Response message for wiping the user's account from the device. + */ + export interface Schema$WipeDeviceUserResponse { + /** + * Resultant DeviceUser object for the action. + */ + deviceUser?: Schema$DeviceUser; + } export class Resource$Groups { context: APIRequestContext; @@ -373,7 +678,7 @@ export namespace cloudidentity_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * @param {string} params.name Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -444,7 +749,7 @@ export namespace cloudidentity_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * @param {string} params.name Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -515,7 +820,7 @@ export namespace cloudidentity_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. * @param {string=} params.pageToken The next_page_token value returned from a previous list request, if any. - * @param {string=} params.parent `Required`. May be made Optional in the future. Customer ID to list all groups from. + * @param {string=} params.parent Required. Customer ID to list all groups from. * @param {string=} params.view Group resource view to be returned. Defaults to [View.BASIC](). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -664,7 +969,7 @@ export namespace cloudidentity_v1 { * * @param {object} params Parameters for request * @param {string} params.name Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where group_id is the unique ID assigned to the Group. Must be left blank while creating a Group. - * @param {string=} params.updateMask Editable fields: `display_name`, `description` + * @param {string=} params.updateMask Required. Editable fields: `display_name`, `description` * @param {().Group} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -738,7 +1043,7 @@ export namespace cloudidentity_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. * @param {string=} params.pageToken The next_page_token value returned from a previous search request, if any. - * @param {string=} params.query `Required`. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match ('==') is supported on parent, and CONTAINS match ('in') is supported on labels. + * @param {string=} params.query Required. `Required`. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match ('==') is supported on parent, and CONTAINS match ('in') is supported on labels. * @param {string=} params.view Group resource view to be returned. Defaults to [View.BASIC](). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -824,7 +1129,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ name?: string; } @@ -835,7 +1140,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group in the format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ name?: string; } @@ -854,7 +1159,7 @@ export namespace cloudidentity_v1 { */ pageToken?: string; /** - * `Required`. May be made Optional in the future. Customer ID to list all groups from. + * Required. Customer ID to list all groups from. */ parent?: string; /** @@ -888,7 +1193,7 @@ export namespace cloudidentity_v1 { */ name?: string; /** - * Editable fields: `display_name`, `description` + * Required. Editable fields: `display_name`, `description` */ updateMask?: string; @@ -912,7 +1217,7 @@ export namespace cloudidentity_v1 { */ pageToken?: string; /** - * `Required`. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match ('==') is supported on parent, and CONTAINS match ('in') is supported on labels. + * Required. `Required`. Query string for performing search on groups. Users can search on parent and label attributes of groups. EXACT match ('==') is supported on parent, and CONTAINS match ('in') is supported on labels. */ query?: string; /** @@ -934,7 +1239,7 @@ export namespace cloudidentity_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * @param {string} params.parent Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. * @param {().Membership} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1010,7 +1315,7 @@ export namespace cloudidentity_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member. + * @param {string} params.name Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1082,7 +1387,7 @@ export namespace cloudidentity_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member. + * @param {string} params.name Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1156,7 +1461,7 @@ export namespace cloudidentity_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The default page size is 200 (max 1000) for the BASIC view, and 50 (max 500) for the FULL view. * @param {string=} params.pageToken The next_page_token value returned from a previous list request, if any. - * @param {string} params.parent [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * @param {string} params.parent Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. * @param {string=} params.view Membership resource view to be returned. Defaults to View.BASIC. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1236,7 +1541,7 @@ export namespace cloudidentity_v1 { * @param {object} params Parameters for request * @param {string=} params.memberKey.id The ID of the entity within the given namespace. The ID must be unique within its namespace. * @param {string=} params.memberKey.namespace Namespaces provide isolation for IDs, so an ID only needs to be unique within its namespace. Namespaces are currently only created as part of IdentitySource creation from Admin Console. A namespace `"identitysources/{identity_source_id}"` is created corresponding to every Identity Source `identity_source_id`. - * @param {string} params.parent [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * @param {string} params.parent Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1322,7 +1627,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to create Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ parent?: string; @@ -1339,7 +1644,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member. + * Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be deleted. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique ID assigned to the Group to which Membership belongs to, and member_id is the unique ID assigned to the member. */ name?: string; } @@ -1351,7 +1656,7 @@ export namespace cloudidentity_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member. + * Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Membership to be retrieved. Format: `groups/{group_id}/memberships/{member_id}`, where `group_id` is the unique id assigned to the Group to which Membership belongs to, and `member_id` is the unique ID assigned to the member. */ name?: string; } @@ -1371,7 +1676,7 @@ export namespace cloudidentity_v1 { */ pageToken?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to list Memberships within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ parent?: string; /** @@ -1395,7 +1700,7 @@ export namespace cloudidentity_v1 { */ 'memberKey.namespace'?: string; /** - * [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. + * Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Group to lookup Membership within. Format: `groups/{group_id}`, where `group_id` is the unique ID assigned to the Group. */ parent?: string; } diff --git a/src/apis/cloudidentity/v1beta1.ts b/src/apis/cloudidentity/v1beta1.ts index 6b9885738b..ebe814be08 100644 --- a/src/apis/cloudidentity/v1beta1.ts +++ b/src/apis/cloudidentity/v1beta1.ts @@ -120,11 +120,11 @@ export namespace cloudidentity_v1beta1 { */ export interface Schema$EntityKey { /** - * The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. + * The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. */ id?: string | null; /** - * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. + * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console. Must be of the form `identitysources/{identity_source_id}. */ namespace?: string | null; } @@ -153,7 +153,7 @@ export namespace cloudidentity_v1beta1 { */ groupKey?: Schema$EntityKey; /** - * Required. The labels that apply to the `Group`. Must not contain more than one entry. Must contain the entry `'system/groups/external': ''` if the `Group` is an external-identity-mapped group or `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group` is a Google Group. + * Required. The labels that apply to the `Group`. Must not contain more than one entry. Must contain the entry `'cloudidentity.googleapis.com/groups.discussion_forum': ''` if the `Group` is a Google Group or `'system/groups/external': ''` if the `Group` is an external-identity-mapped group. */ labels?: {[key: string]: string} | null; /** @@ -169,6 +169,19 @@ export namespace cloudidentity_v1beta1 { */ updateTime?: string | null; } + /** + * The response message for GroupsService.ListGroups. + */ + export interface Schema$ListGroupsResponse { + /** + * The `Group`s under the specified `parent`. + */ + groups?: Schema$Group[]; + /** + * A continuation token to retrieve the next page of results, or empty if there are no more results available. + */ + nextPageToken?: string | null; + } /** * The response message for MembershipsService.ListMemberships. */ @@ -187,7 +200,7 @@ export namespace cloudidentity_v1beta1 { */ export interface Schema$LookupGroupNameResponse { /** - * The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`. + * Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`. */ name?: string | null; } @@ -216,6 +229,10 @@ export namespace cloudidentity_v1beta1 { * Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group_id}/memberships/{membership_id}`. */ name?: string | null; + /** + * Required. Immutable. The `EntityKey` of the member. Either `member_key` or `preferred_member_key` must be set when calling MembershipsService.CreateMembership but not both; both shall be set when returned. + */ + preferredMemberKey?: Schema$EntityKey; /** * The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`. */ @@ -234,6 +251,32 @@ export namespace cloudidentity_v1beta1 { */ name?: string | null; } + /** + * The request message for MembershipsService.ModifyMembershipRoles. + */ + export interface Schema$ModifyMembershipRolesRequest { + /** + * The `MembershipRole`s to be added. Adding or removing roles in the same request as updating roles is not supported. Must not be set if `update_roles_params` is set. + */ + addRoles?: Schema$MembershipRole[]; + /** + * The `name`s of the `MembershipRole`s to be removed. Adding or removing roles in the same request as updating roles is not supported. It is not possible to remove the `MEMBER` `MembershipRole`. If you wish to delete a `Membership`, call MembershipsService.DeleteMembership instead. Must not contain `MEMBER`. Must not be set if `update_roles_params` is set. + */ + removeRoles?: string[] | null; + /** + * The `MembershipRole`s to be updated. Updating roles in the same request as adding or removing roles is not supported. Must not be set if either `add_roles` or `remove_roles` is set. + */ + updateRolesParams?: Schema$UpdateMembershipRolesParams[]; + } + /** + * The response message for MembershipsService.ModifyMembershipRoles. + */ + export interface Schema$ModifyMembershipRolesResponse { + /** + * The `Membership` resource after modifying its `MembershipRole`s. + */ + membership?: Schema$Membership; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -289,6 +332,19 @@ export namespace cloudidentity_v1beta1 { */ message?: string | null; } + /** + * The details of an update to a `MembershipRole`. + */ + export interface Schema$UpdateMembershipRolesParams { + /** + * The fully-qualified names of fields to update. May only contain the field `expiry_detail`. + */ + fieldMask?: string | null; + /** + * The `MembershipRole`s to be updated. Only `MEMBER` `MembershipRoles` can currently be updated. May only contain a `MembershipRole` with `name` `MEMBER`. + */ + membershipRole?: Schema$MembershipRole; + } export class Resource$Groups { context: APIRequestContext; @@ -305,6 +361,7 @@ export namespace cloudidentity_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.initialGroupConfig Required. The initial configuration option for the `Group`. * @param {().Group} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -376,7 +433,7 @@ export namespace cloudidentity_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. + * @param {string} params.name Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_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 @@ -447,7 +504,7 @@ export namespace cloudidentity_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. + * @param {string} params.name Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_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 @@ -509,6 +566,80 @@ export namespace cloudidentity_v1beta1 { } } + /** + * cloudidentity.groups.list + * @desc Lists the `Group`s under a customer or namespace. + * @alias cloudidentity.groups.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`. + * @param {string=} params.pageToken The `next_page_token` value returned from a previous list request, if any. + * @param {string=} params.parent Required. The parent resource under which to list all `Group`s. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + * @param {string=} params.view The level of detail to be returned. If unspecified, defaults to `View.BASIC`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Groups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Groups$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Groups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Groups$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Groups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Groups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/groups').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * cloudidentity.groups.lookup * @desc Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`. @@ -516,8 +647,8 @@ export namespace cloudidentity_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.groupKey.id The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. - * @param {string=} params.groupKey.namespace The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. + * @param {string=} params.groupKey.id The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. + * @param {string=} params.groupKey.namespace The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console. Must be of the form `identitysources/{identity_source_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 @@ -596,7 +727,7 @@ export namespace cloudidentity_v1beta1 { * * @param {object} params Parameters for request * @param {string} params.name Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. - * @param {string=} params.updateMask The fully-qualified names of fields to update. May only contain the following fields: `display_name`, `description`. + * @param {string=} params.updateMask Required. The fully-qualified names of fields to update. May only contain the following fields: `display_name`, `description`. * @param {().Group} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -670,7 +801,7 @@ export namespace cloudidentity_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. * @param {string=} params.pageToken The `next_page_token` value returned from a previous search request, if any. - * @param {string=} params.query The search query. Only queries on the parent and labels of `Group`s are supported. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent (e.g. `parent == 'customers/{customer_id}'`) and inclusion operators on labels (e.g., `'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). + * @param {string=} params.query Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). * @param {string=} params.view The level of detail to be returned. If unspecified, defaults to `View.BASIC`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -747,6 +878,11 @@ export namespace cloudidentity_v1beta1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Required. The initial configuration option for the `Group`. + */ + initialGroupConfig?: string; + /** * Request body metadata */ @@ -759,7 +895,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. + * Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. */ name?: string; } @@ -770,10 +906,33 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. + * Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. */ name?: string; } + export interface Params$Resource$Groups$List extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`. + */ + pageSize?: number; + /** + * The `next_page_token` value returned from a previous list request, if any. + */ + pageToken?: string; + /** + * Required. The parent resource under which to list all `Group`s. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. + */ + parent?: string; + /** + * The level of detail to be returned. If unspecified, defaults to `View.BASIC`. + */ + view?: string; + } export interface Params$Resource$Groups$Lookup extends StandardParameters { /** * Auth client or API Key for the request @@ -781,11 +940,11 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. + * The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. */ 'groupKey.id'?: string; /** - * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. + * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console. Must be of the form `identitysources/{identity_source_id}. */ 'groupKey.namespace'?: string; } @@ -800,7 +959,7 @@ export namespace cloudidentity_v1beta1 { */ name?: string; /** - * The fully-qualified names of fields to update. May only contain the following fields: `display_name`, `description`. + * Required. The fully-qualified names of fields to update. May only contain the following fields: `display_name`, `description`. */ updateMask?: string; @@ -824,7 +983,7 @@ export namespace cloudidentity_v1beta1 { */ pageToken?: string; /** - * The search query. Only queries on the parent and labels of `Group`s are supported. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent (e.g. `parent == 'customers/{customer_id}'`) and inclusion operators on labels (e.g., `'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). + * Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == 'customers/{customer_id}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels`). */ query?: string; /** @@ -846,7 +1005,7 @@ export namespace cloudidentity_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. + * @param {string} params.parent Required. The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. * @param {().Membership} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -922,7 +1081,7 @@ export namespace cloudidentity_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_id}`. + * @param {string} params.name Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_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 @@ -994,7 +1153,7 @@ export namespace cloudidentity_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_id}`. + * @param {string} params.name Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_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 @@ -1068,7 +1227,7 @@ export namespace cloudidentity_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and to 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`. * @param {string=} params.pageToken The `next_page_token` value returned from a previous search request, if any. - * @param {string} params.parent The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. + * @param {string} params.parent Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. * @param {string=} params.view The level of detail to be returned. If unspecified, defaults to `MembershipView.BASIC`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1146,9 +1305,9 @@ export namespace cloudidentity_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.memberKey.id The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. - * @param {string=} params.memberKey.namespace The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. - * @param {string} params.parent The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. + * @param {string=} params.memberKey.id The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. + * @param {string=} params.memberKey.namespace The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console. Must be of the form `identitysources/{identity_source_id}. + * @param {string} params.parent Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_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 @@ -1224,6 +1383,91 @@ export namespace cloudidentity_v1beta1 { ); } } + + /** + * cloudidentity.groups.memberships.modifyMembershipRoles + * @desc Modifies the `MembershipRole`s of a `Membership`. + * @alias cloudidentity.groups.memberships.modifyMembershipRoles + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` whose roles are to be modified. Must be of the form `groups/{group_id}/memberships/{membership_id}`. + * @param {().ModifyMembershipRolesRequest} params.requestBody Request 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 + */ + modifyMembershipRoles( + params?: Params$Resource$Groups$Memberships$Modifymembershiproles, + options?: MethodOptions + ): GaxiosPromise; + modifyMembershipRoles( + params: Params$Resource$Groups$Memberships$Modifymembershiproles, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + modifyMembershipRoles( + params: Params$Resource$Groups$Memberships$Modifymembershiproles, + callback: BodyResponseCallback + ): void; + modifyMembershipRoles( + callback: BodyResponseCallback + ): void; + modifyMembershipRoles( + paramsOrCallback?: + | Params$Resource$Groups$Memberships$Modifymembershiproles + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Groups$Memberships$Modifymembershiproles; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Groups$Memberships$Modifymembershiproles; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://cloudidentity.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:modifyMembershipRoles').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$Groups$Memberships$Create @@ -1234,7 +1478,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. + * Required. The parent `Group` resource under which to create the `Membership`. Must be of the form `groups/{group_id}`. */ parent?: string; @@ -1251,7 +1495,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_id}`. + * Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to delete. Must be of the form `groups/{group_id}/memberships/{membership_id}`. */ name?: string; } @@ -1263,7 +1507,7 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_id}`. + * Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` to retrieve. Must be of the form `groups/{group_id}/memberships/{membership_id}`. */ name?: string; } @@ -1283,7 +1527,7 @@ export namespace cloudidentity_v1beta1 { */ pageToken?: string; /** - * The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. + * Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. */ parent?: string; /** @@ -1299,16 +1543,33 @@ export namespace cloudidentity_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The ID of the entity. For Google-managed entities, the `id` must be the email address of a group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. + * The ID of the entity. For Google-managed entities, the `id` must be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source's requirements. Must be unique within a `namespace`. */ 'memberKey.id'?: string; /** - * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group created through Admin Console. Must be of the form `identitysources/{identity_source_id}. + * The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console. Must be of the form `identitysources/{identity_source_id}. */ 'memberKey.namespace'?: string; /** - * The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. + * Required. The parent `Group` resource under which to lookup the `Membership` name. Must be of the form `groups/{group_id}`. */ parent?: string; } + export interface Params$Resource$Groups$Memberships$Modifymembershiproles + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership` whose roles are to be modified. Must be of the form `groups/{group_id}/memberships/{membership_id}`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ModifyMembershipRolesRequest; + } } diff --git a/src/apis/cloudiot/v1.ts b/src/apis/cloudiot/v1.ts index f99a2ae1f9..00c3ca87f9 100644 --- a/src/apis/cloudiot/v1.ts +++ b/src/apis/cloudiot/v1.ts @@ -324,23 +324,23 @@ export namespace cloudiot_v1 { subfolderMatches?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudkms/v1.ts b/src/apis/cloudkms/v1.ts index 9ca6966448..8acdd37ac2 100644 --- a/src/apis/cloudkms/v1.ts +++ b/src/apis/cloudkms/v1.ts @@ -371,23 +371,23 @@ export namespace cloudkms_v1 { name?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -598,6 +598,10 @@ export namespace cloudkms_v1 { * Cloud KMS metadata for the given google.cloud.location.Location. */ export interface Schema$LocationMetadata { + /** + * Indicates whether CryptoKeys with protection_level EXTERNAL can be created in this location. + */ + ekmAvailable?: boolean | null; /** * Indicates whether CryptoKeys with protection_level HSM can be created in this location. */ diff --git a/src/apis/cloudprivatecatalogproducer/v1beta1.ts b/src/apis/cloudprivatecatalogproducer/v1beta1.ts index 637cbf5375..17653fbe0b 100644 --- a/src/apis/cloudprivatecatalogproducer/v1beta1.ts +++ b/src/apis/cloudprivatecatalogproducer/v1beta1.ts @@ -439,23 +439,23 @@ export namespace cloudprivatecatalogproducer_v1beta1 { message?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$GoogleTypeExpr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudresourcemanager/v1.ts b/src/apis/cloudresourcemanager/v1.ts index 9c79a8bf48..6cc5fbae1b 100644 --- a/src/apis/cloudresourcemanager/v1.ts +++ b/src/apis/cloudresourcemanager/v1.ts @@ -239,23 +239,23 @@ export namespace cloudresourcemanager_v1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -1842,7 +1842,7 @@ export namespace cloudresourcemanager_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name/identifier of the Lien to delete. + * @param {string} params.name Required. The name/identifier of the Lien 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 @@ -1957,7 +1957,7 @@ export namespace cloudresourcemanager_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name/identifier of the Lien. + * @param {string} params.name Required. The name/identifier of the Lien. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2084,7 +2084,7 @@ export namespace cloudresourcemanager_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of items to return. This is a suggestion for the server. * @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 resource to list all attached Liens. For example, `projects/1234`. + * @param {string=} params.parent Required. The name of the resource to list all attached Liens. For example, `projects/1234`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2167,7 +2167,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name/identifier of the Lien to delete. + * Required. The name/identifier of the Lien to delete. */ name?: string; } @@ -2178,7 +2178,7 @@ export namespace cloudresourcemanager_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name/identifier of the Lien. + * Required. The name/identifier of the Lien. */ name?: string; } @@ -2197,7 +2197,7 @@ export namespace cloudresourcemanager_v1 { */ pageToken?: string; /** - * The name of the resource to list all attached Liens. For example, `projects/1234`. + * Required. The name of the resource to list all attached Liens. For example, `projects/1234`. */ parent?: string; } diff --git a/src/apis/cloudresourcemanager/v1beta1.ts b/src/apis/cloudresourcemanager/v1beta1.ts index 24e4f551ae..25dae0d3d6 100644 --- a/src/apis/cloudresourcemanager/v1beta1.ts +++ b/src/apis/cloudresourcemanager/v1beta1.ts @@ -174,23 +174,23 @@ export namespace cloudresourcemanager_v1beta1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudresourcemanager/v2.ts b/src/apis/cloudresourcemanager/v2.ts index 491a88ccd4..7ba5d72b02 100644 --- a/src/apis/cloudresourcemanager/v2.ts +++ b/src/apis/cloudresourcemanager/v2.ts @@ -161,23 +161,23 @@ export namespace cloudresourcemanager_v2 { role?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudresourcemanager/v2beta1.ts b/src/apis/cloudresourcemanager/v2beta1.ts index 5ac7997290..f2a11deb4e 100644 --- a/src/apis/cloudresourcemanager/v2beta1.ts +++ b/src/apis/cloudresourcemanager/v2beta1.ts @@ -161,23 +161,23 @@ export namespace cloudresourcemanager_v2beta1 { role?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudsearch/v1.ts b/src/apis/cloudsearch/v1.ts index 97cd1cb1d9..810dc8f973 100644 --- a/src/apis/cloudsearch/v1.ts +++ b/src/apis/cloudsearch/v1.ts @@ -230,7 +230,7 @@ export namespace cloudsearch_v1 { */ indexingServiceAccounts?: string[] | null; /** - * This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. This should not be set if anonymous search is enabled for the data source. + * This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. */ itemsVisibility?: Schema$GSuitePrincipal[]; /** @@ -1266,7 +1266,7 @@ export namespace cloudsearch_v1 { */ isSuggestable?: boolean | null; /** - * Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. Note: This is an alpha feature and is enabled for whitelisted users only. + * Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. */ isWildcardSearchable?: boolean | null; /** @@ -4157,7 +4157,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.query.search - * @desc The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. + * @desc The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from G Suite Apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). * @alias cloudsearch.query.search * @memberOf! () * @@ -4227,7 +4227,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.query.suggest - * @desc Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. + * @desc Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). * @alias cloudsearch.query.suggest * @memberOf! () * @@ -4327,7 +4327,7 @@ export namespace cloudsearch_v1 { /** * cloudsearch.query.sources.list - * @desc Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. + * @desc Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [G Suite domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). * @alias cloudsearch.query.sources.list * @memberOf! () * diff --git a/src/apis/cloudtasks/v2.ts b/src/apis/cloudtasks/v2.ts index e439bc614e..bbfdc711ff 100644 --- a/src/apis/cloudtasks/v2.ts +++ b/src/apis/cloudtasks/v2.ts @@ -217,23 +217,23 @@ export namespace cloudtasks_v2 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudtasks/v2beta2.ts b/src/apis/cloudtasks/v2beta2.ts index b237a1644f..e87f06544e 100644 --- a/src/apis/cloudtasks/v2beta2.ts +++ b/src/apis/cloudtasks/v2beta2.ts @@ -248,23 +248,23 @@ export namespace cloudtasks_v2beta2 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index c4ebbd2f0e..2fe8568f01 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -226,23 +226,23 @@ export namespace cloudtasks_v2beta3 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/cloudtrace/index.ts b/src/apis/cloudtrace/index.ts index ffe3fc7dec..52aa9049ea 100644 --- a/src/apis/cloudtrace/index.ts +++ b/src/apis/cloudtrace/index.ts @@ -16,10 +16,12 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {cloudtrace_v1} from './v1'; import {cloudtrace_v2} from './v2'; +import {cloudtrace_v2beta1} from './v2beta1'; export const VERSIONS = { v1: cloudtrace_v1.Cloudtrace, v2: cloudtrace_v2.Cloudtrace, + v2beta1: cloudtrace_v2beta1.Cloudtrace, }; export function cloudtrace(version: 'v1'): cloudtrace_v1.Cloudtrace; @@ -30,11 +32,24 @@ export function cloudtrace(version: 'v2'): cloudtrace_v2.Cloudtrace; export function cloudtrace( options: cloudtrace_v2.Options ): cloudtrace_v2.Cloudtrace; +export function cloudtrace(version: 'v2beta1'): cloudtrace_v2beta1.Cloudtrace; +export function cloudtrace( + options: cloudtrace_v2beta1.Options +): cloudtrace_v2beta1.Cloudtrace; export function cloudtrace< - T = cloudtrace_v1.Cloudtrace | cloudtrace_v2.Cloudtrace + T = + | cloudtrace_v1.Cloudtrace + | cloudtrace_v2.Cloudtrace + | cloudtrace_v2beta1.Cloudtrace >( this: GoogleConfigurable, - versionOrOptions: 'v1' | cloudtrace_v1.Options | 'v2' | cloudtrace_v2.Options + versionOrOptions: + | 'v1' + | cloudtrace_v1.Options + | 'v2' + | cloudtrace_v2.Options + | 'v2beta1' + | cloudtrace_v2beta1.Options ) { return getAPI('cloudtrace', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/cloudtrace/v1.ts b/src/apis/cloudtrace/v1.ts index 954ec05a0f..b7e9526c08 100644 --- a/src/apis/cloudtrace/v1.ts +++ b/src/apis/cloudtrace/v1.ts @@ -202,7 +202,7 @@ export namespace cloudtrace_v1 { /** * cloudtrace.projects.patchTraces - * @desc Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created. + * @desc Sends new traces to Stackdriver Trace or updates existing traces. If the ID of a trace that you send matches that of an existing trace, any fields in the existing trace and its spans are overwritten by the provided values, and any new fields provided are merged with the existing trace data. If the ID does not match, a new trace is created. In this case, writing traces is not considered an active developer method since traces are machine generated. * @example * * // BEFORE RUNNING: * // --------------- @@ -348,7 +348,7 @@ export namespace cloudtrace_v1 { /** * cloudtrace.projects.traces.get - * @desc Gets a single trace by its ID. + * @desc Gets a single trace by its ID. In this case, getting for traces is considered an active developer method, even though it is technically a read-only method. * @example * * // BEFORE RUNNING: * // --------------- @@ -469,7 +469,7 @@ export namespace cloudtrace_v1 { /** * cloudtrace.projects.traces.list - * @desc Returns of a list of traces that match the specified filter conditions. + * @desc Returns of a list of traces that match the specified filter conditions. In this case, listing for traces is considered an active developer method, even though it is technically a read-only method. * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/cloudtrace/v2.ts b/src/apis/cloudtrace/v2.ts index 4e67b48567..70c98994b8 100644 --- a/src/apis/cloudtrace/v2.ts +++ b/src/apis/cloudtrace/v2.ts @@ -443,7 +443,7 @@ export namespace cloudtrace_v2 { /** * cloudtrace.projects.traces.batchWrite - * @desc Sends new spans to new or existing traces. You cannot update existing spans. + * @desc Sends new spans to new or existing traces. You cannot update existing spans. In this case, writing traces is not considered an active developer method since traces are machine generated. * @alias cloudtrace.projects.traces.batchWrite * @memberOf! () * @@ -541,7 +541,7 @@ export namespace cloudtrace_v2 { /** * cloudtrace.projects.traces.spans.createSpan - * @desc Creates a new span. + * @desc Creates a new span. In this case, writing traces is not considered an active developer method since traces are machine generated. * @alias cloudtrace.projects.traces.spans.createSpan * @memberOf! () * diff --git a/src/apis/cloudtrace/v2beta1.ts b/src/apis/cloudtrace/v2beta1.ts new file mode 100644 index 0000000000..3e34f084cf --- /dev/null +++ b/src/apis/cloudtrace/v2beta1.ts @@ -0,0 +1,626 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace cloudtrace_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 Trace API + * + * Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus. + * + * @example + * const {google} = require('googleapis'); + * const cloudtrace = google.cloudtrace('v2beta1'); + * + * @namespace cloudtrace + * @type {Function} + * @version v2beta1 + * @variation v2beta1 + * @param {object=} options Options for Cloudtrace + */ + export class Cloudtrace { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Result returned from `ListTraceSinks`. + */ + export interface Schema$ListTraceSinksResponse { + /** + * 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 | null; + /** + * A list of sinks. + */ + sinks?: Schema$TraceSink[]; + } + /** + * OutputConfig contains a destination for writing trace data. + */ + export interface Schema$OutputConfig { + /** + * The destination for writing trace data. Currently only BigQuery is supported. E.g.: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + */ + destination?: string | null; + } + /** + * Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. + */ + export interface Schema$TraceSink { + /** + * Required. The canonical sink resource name, unique within the project. Must be of the form: project/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + */ + name?: string | null; + /** + * Required. The export destination. + */ + outputConfig?: Schema$OutputConfig; + /** + * Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and write data this account will need the dataEditor role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control#permissions_and_roles). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" + */ + writerIdentity?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + traceSinks: Resource$Projects$Tracesinks; + constructor(context: APIRequestContext) { + this.context = context; + this.traceSinks = new Resource$Projects$Tracesinks(this.context); + } + } + + export class Resource$Projects$Tracesinks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * cloudtrace.projects.traceSinks.create + * @desc Creates a sink that exports trace spans to a destination. The export of newly-ingested traces begins immediately, unless the sink's `writer_identity` is not permitted to write to the destination. A sink can export traces only from the resource owning the sink (the 'parent'). + * @alias cloudtrace.projects.traceSinks.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The resource in which to create the sink (currently only project sinks are supported): "projects/[PROJECT_ID]" Examples: `"projects/my-trace-project"`, `"projects/123456789"`. + * @param {().TraceSink} params.requestBody Request 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$Tracesinks$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Tracesinks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Tracesinks$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Tracesinks$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Tracesinks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Tracesinks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudtrace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/traceSinks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudtrace.projects.traceSinks.delete + * @desc Deletes a sink. + * @alias cloudtrace.projects.traceSinks.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]" Example: `"projects/12345/traceSinks/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$Tracesinks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Tracesinks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Tracesinks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Tracesinks$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Tracesinks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Tracesinks$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudtrace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudtrace.projects.traceSinks.get + * @desc Get a trace sink by name under the parent resource (GCP project). + * @alias cloudtrace.projects.traceSinks.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the sink: "projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]" Example: `"projects/12345/traceSinks/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$Tracesinks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Tracesinks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Tracesinks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Tracesinks$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Tracesinks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Tracesinks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudtrace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudtrace.projects.traceSinks.list + * @desc List all sinks for the parent resource (GCP project). + * @alias cloudtrace.projects.traceSinks.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 (currently only project parent resources are supported): "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$Tracesinks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Tracesinks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Tracesinks$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Tracesinks$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Tracesinks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Tracesinks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudtrace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+parent}/traceSinks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * cloudtrace.projects.traceSinks.patch + * @desc Updates a sink. This method updates fields in the existing sink according to the provided update mask. The sink's name cannot be changed nor any output-only fields (e.g. the writer_identity). + * @alias cloudtrace.projects.traceSinks.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]" Example: `"projects/12345/traceSinks/my-sink-id"`. + * @param {string=} params.updateMask Required. Field mask that specifies the fields in `trace_sink` that are to be updated. A sink field is overwritten if, and only if, it is in the update mask. `name` and `writer_identity` fields cannot be updated. An empty updateMask is considered an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Example: `updateMask=output_config`. + * @param {().TraceSink} params.requestBody Request 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$Tracesinks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Tracesinks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Tracesinks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Tracesinks$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Tracesinks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Tracesinks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudtrace.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta1/{+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$Tracesinks$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 (currently only project sinks are supported): "projects/[PROJECT_ID]" Examples: `"projects/my-trace-project"`, `"projects/123456789"`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TraceSink; + } + export interface Params$Resource$Projects$Tracesinks$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_NUMBER]/traceSinks/[SINK_ID]" Example: `"projects/12345/traceSinks/my-sink-id"`. + */ + name?: string; + } + export interface Params$Resource$Projects$Tracesinks$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_NUMBER]/traceSinks/[SINK_ID]" Example: `"projects/12345/traceSinks/my-sink-id"`. + */ + name?: string; + } + export interface Params$Resource$Projects$Tracesinks$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 (currently only project parent resources are supported): "projects/[PROJECT_ID]" + */ + parent?: string; + } + export interface Params$Resource$Projects$Tracesinks$Patch + 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_NUMBER]/traceSinks/[SINK_ID]" Example: `"projects/12345/traceSinks/my-sink-id"`. + */ + name?: string; + /** + * Required. Field mask that specifies the fields in `trace_sink` that are to be updated. A sink field is overwritten if, and only if, it is in the update mask. `name` and `writer_identity` fields cannot be updated. An empty updateMask is considered an error. For a detailed `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask Example: `updateMask=output_config`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TraceSink; + } +} diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index a98edc430b..b3d117b748 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -136,7 +136,7 @@ export namespace composer_v1 { */ labels?: {[key: string]: string} | null; /** - * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. */ name?: string | null; /** diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index 80c4c8355f..3170d1a8f3 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -115,6 +115,19 @@ export namespace composer_v1beta1 { } } + /** + * Allowed IP range with user-provided description. + */ + export interface Schema$AllowedIpRange { + /** + * Optional. User-provided description. It must contain at most 300 characters. + */ + description?: string | null; + /** + * IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character "*" to match all IPs equivalent to "0/0" and "::/0" together. Examples: `192.168.1.1` or `192.168.0.0/16` or `2001:db8::/32` or `2001:0db8:0000:0042:0000:8a2e:0370:7334`. <p>IP range prefixes should be properly truncated. For example, `1.2.3.4/24` should be truncated to `1.2.3.0/24`. Similarly, for IPv6, `2001:db8::1/32` should be truncated to `2001:db8::/32`. + */ + value?: string | null; + } /** * 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 `{}`. */ @@ -136,7 +149,7 @@ export namespace composer_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" + * The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. */ name?: string | null; /** @@ -184,6 +197,10 @@ export namespace composer_v1beta1 { * The configuration settings for software inside the environment. */ softwareConfig?: Schema$SoftwareConfig; + /** + * Optional. The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied. + */ + webServerNetworkAccessControl?: Schema$WebServerNetworkAccessControl; } /** * Image Version information @@ -429,6 +446,15 @@ export namespace composer_v1beta1 { */ message?: string | null; } + /** + * Network-level access control policy for the Airflow web server. + */ + export interface Schema$WebServerNetworkAccessControl { + /** + * A collection of allowed IP ranges with descriptions. + */ + allowedIpRanges?: Schema$AllowedIpRange[]; + } export class Resource$Projects { context: APIRequestContext; diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index c86b8e55c2..ec6116dc01 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -309,7 +309,7 @@ export namespace compute_alpha { acceleratorType?: string | null; } /** - * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) + * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for {$api_version}.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -459,7 +459,7 @@ export namespace compute_alpha { */ publicPtrDomainName?: string | null; /** - * Specifies whether a public DNS ?A? record should be created for the external IP address of this access configuration. + * Specifies whether a public DNS 'A' record should be created for the external IP address of this access configuration. */ setPublicDns?: boolean | null; /** @@ -472,7 +472,7 @@ export namespace compute_alpha { type?: string | null; } /** - * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) + * Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier. Use global internal addresses for reserved peering network range. Use regional external addresses for the following resources: - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA) Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes: - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses For more information, read reserved IP address. (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==) */ export interface Schema$Address { /** @@ -715,7 +715,7 @@ export namespace compute_alpha { */ diskEncryptionKey?: Schema$CustomerEncryptionKey; /** - * The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. + * The size of the disk in GB. */ diskSizeGb?: string | null; /** @@ -888,7 +888,7 @@ export namespace compute_alpha { permissionType?: string | null; } /** - * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * [Global](/compute/docs/reference/rest/latest/autoscalers) * [Regional](/compute/docs/reference/rest/latest/regionAutoscalers) Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** @@ -1077,6 +1077,10 @@ export namespace compute_alpha { * CPU utilization policy. */ export interface Schema$AutoscalingPolicyCpuUtilization { + /** + * Indicates which method of prediction is used for CPU utilization metric, if any. Current set of possible values: * NONE: No predictions are made based on the scaling metric when calculating the number of VM instances. * STANDARD: Standard predictive autoscaling predicts the future values of the scaling metric and then scales a MIG to ensure that new VM instances are ready in time to cover the predicted peak. New values might be added in the future. Some of the values might not be available in all API versions. + */ + predictiveMethod?: string | null; /** * The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6. If the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization. If the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization. */ @@ -1154,6 +1158,10 @@ export namespace compute_alpha { * Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step. */ maxScaledDownReplicas?: Schema$FixedOrPercent; + /** + * How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above. + */ + timeWindow?: Schema$GoogleDuration; /** * How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above. */ @@ -1304,7 +1312,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Backend Service resource. A backend service contains configuration values for Google Cloud Platform load balancing services. For more information, read Backend Services. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * Represents a Backend Service resource. A backend service contains configuration values for Google Cloud Platform load balancing services. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](/compute/docs/reference/rest/latest/backendServices) * [Regional](/compute/docs/reference/rest/latest/regionBackendServices) For more information, read Backend Services. (== resource_for {$api_version}.backendService ==) */ export interface Schema$BackendService { /** @@ -1353,7 +1361,7 @@ export namespace compute_alpha { */ fingerprint?: string | null; /** - * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. + * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified. Health check is optional for Compute Engine backend services if there is no backend. A health check must not be specified when adding Internet Network Endpoint Group or Serverless Network Endpoint Group as backends. In all other cases, a health check is required for Compute Engine backend services. For internal load balancing, a URL to a HealthCheck resource must be specified instead. */ healthChecks?: string[] | null; iap?: Schema$BackendServiceIAP; @@ -1755,7 +1763,7 @@ export namespace compute_alpha { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,`alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -1872,7 +1880,7 @@ export namespace compute_alpha { subjectAltNames?: string[] | null; } /** - * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) + * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==) */ export interface Schema$Commitment { /** @@ -1900,9 +1908,9 @@ export namespace compute_alpha { */ kind?: string | null; /** - * A list of commitment amounts for particular licenses. + * The license specification required as part of a license commitment. */ - licenseResources?: Schema$LicenseResourceCommitment[]; + licenseResource?: Schema$LicenseResourceCommitment; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ @@ -2135,7 +2143,7 @@ export namespace compute_alpha { */ exposeHeaders?: string[] | null; /** - * Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. + * Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header. */ maxAge?: number | null; } @@ -2200,7 +2208,7 @@ export namespace compute_alpha { state?: string | null; } /** - * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) + * Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Global](/compute/docs/reference/rest/latest/disks) * [Regional](/compute/docs/reference/rest/latest/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==) */ export interface Schema$Disk { /** @@ -2479,7 +2487,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) + * Represents a Disk Type resource. Google Compute Engine has two Disk Type resources: * [Global](/compute/docs/reference/rest/latest/diskTypes) * [Regional](/compute/docs/reference/rest/latest/regionDiskTypes) You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for {$api_version}.diskTypes ==) (== resource_for {$api_version}.regionDiskTypes ==) */ export interface Schema$DiskType { /** @@ -2699,28 +2707,28 @@ export namespace compute_alpha { } | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } /** - * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. + * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. */ export interface Schema$ExternalVpnGateway { /** @@ -2773,7 +2781,7 @@ export namespace compute_alpha { */ id?: number | null; /** - * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider?s VPN gateway, it cannot be an IP address from Google Compute Engine. + * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. */ ipAddress?: string | null; } @@ -2971,7 +2979,7 @@ export namespace compute_alpha { percent?: number | null; } /** - * Represents a Forwarding Rule resource. A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * Represents a Forwarding Rule resource. Forwarding rule resources in GCP can be either regional or global in scope: * [Global](/compute/docs/reference/rest/latest/globalForwardingRules) * [Regional](/compute/docs/reference/rest/latest/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding. (== resource_for {$api_version}.forwardingRules ==) (== resource_for {$api_version}.globalForwardingRules ==) (== resource_for {$api_version}.regionForwardingRules ==) */ export interface Schema$ForwardingRule { /** @@ -3031,7 +3039,7 @@ export namespace compute_alpha { */ labels?: {[key: string]: string} | null; /** - * Specifies the forwarding rule type. EXTERNAL is used for: - Classic Cloud VPN gateways - Protocol forwarding to VMs from an external IP address - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP. INTERNAL is used for: - Protocol forwarding to VMs from an internal IP address - Internal TCP/UDP load balancers INTERNAL_MANAGED is used for: - Internal HTTP(S) load balancers INTERNAL_SELF_MANAGED is used for: - Traffic Director For more information about forwarding rules, refer to Forwarding rule concepts. + * Specifies the forwarding rule type. - EXTERNAL is used for: - Classic Cloud VPN gateways - Protocol forwarding to VMs from an external IP address - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP - INTERNAL is used for: - Protocol forwarding to VMs from an internal IP address - Internal TCP/UDP load balancers - INTERNAL_MANAGED is used for: - Internal HTTP(S) load balancers - >INTERNAL_SELF_MANAGED is used for: - Traffic Director For more information about forwarding rules, refer to Forwarding rule concepts. */ loadBalancingScheme?: string | null; /** @@ -3083,7 +3091,7 @@ export namespace compute_alpha { */ subnetwork?: string | null; /** - * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. + * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only targetHttpProxy is valid, not targetHttpsProxy. */ target?: string | null; } @@ -3203,6 +3211,19 @@ export namespace compute_alpha { */ policy?: Schema$Policy; } + /** + * A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # Examples Example 1: Compute Duration from two Timestamps in pseudo code. Timestamp start = ...; Timestamp end = ...; Duration duration = ...; duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos; if (duration.seconds 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (duration.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; } Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. Timestamp start = ...; Duration duration = ...; Timestamp end = ...; end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos; if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; } Example 3: Compute Duration from datetime.timedelta in Python. td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td) # JSON Mapping In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s". + */ + export interface Schema$GoogleDuration { + /** + * Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive. + */ + nanos?: number | null; + /** + * Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + */ + seconds?: string | null; + } /** * gRPC config to access the SDS server. */ @@ -3282,7 +3303,7 @@ export namespace compute_alpha { type?: string | null; } /** - * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. + * Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/latest/healthChecks) * [Regional](/compute/docs/reference/rest/latest/regionHealthChecks) Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. */ export interface Schema$HealthCheck { /** @@ -3438,6 +3459,10 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. + */ + fingerprint?: string | null; /** * List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs. */ @@ -3547,11 +3572,11 @@ export namespace compute_alpha { */ instance?: string | null; /** - * The IP address represented by this resource. + * A forwarding rule IP address assigned to this instance. */ ipAddress?: string | null; /** - * The port on the instance. + * The named port of the instance group, not necessarily the port that is health-checked. */ port?: number | null; } @@ -3709,11 +3734,11 @@ export namespace compute_alpha { */ presentMatch?: boolean | null; /** - * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. */ rangeMatch?: Schema$Int64RangeMatch; /** - * The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; /** @@ -3879,7 +3904,7 @@ export namespace compute_alpha { */ presentMatch?: boolean | null; /** - * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; } @@ -3896,11 +3921,11 @@ export namespace compute_alpha { */ httpsRedirect?: boolean | null; /** - * The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters. + * The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. */ pathRedirect?: string | null; /** - * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. + * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. */ prefixRedirect?: string | null; /** @@ -4018,7 +4043,7 @@ export namespace compute_alpha { */ queryParameterMatches?: Schema$HttpQueryParameterMatch[]; /** - * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; } @@ -4147,7 +4172,7 @@ export namespace compute_alpha { } | null; } /** - * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) + * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==) */ export interface Schema$Image { /** @@ -4334,7 +4359,7 @@ export namespace compute_alpha { pk?: Schema$FileContentBuffer; } /** - * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) + * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==) */ export interface Schema$Instance { /** @@ -4430,6 +4455,10 @@ export namespace compute_alpha { * Total amount of preserved state for SUSPENDED instances. Read-only in the api. */ preservedStateSizeGb?: string | null; + /** + * The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. + */ + privateIpv6GoogleAccess?: string | null; /** * Specifies the reservations that this instance can consume from. */ @@ -4482,6 +4511,10 @@ export namespace compute_alpha { * Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. */ tags?: Schema$Tags; + /** + * [Output Only] Specifies upcoming maintenance for the instance. + */ + upcomingMaintenance?: Schema$UpcomingMaintenance; /** * [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. */ @@ -4518,7 +4551,7 @@ export namespace compute_alpha { } | null; } /** - * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -4642,7 +4675,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) + * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** @@ -4734,7 +4767,7 @@ export namespace compute_alpha { */ targetPools?: string[] | null; /** - * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. + * The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. */ targetSize?: number | null; /** @@ -5352,6 +5385,10 @@ export namespace compute_alpha { * Specifies whether this instance will be shut down on key revocation. */ postKeyRevocationActionType?: string | null; + /** + * The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. + */ + privateIpv6GoogleAccess?: string | null; /** * Specifies the reservations that this instance can consume from. */ @@ -5499,7 +5536,7 @@ export namespace compute_alpha { instanceEncryptionKey?: Schema$CustomerEncryptionKey; } /** - * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) + * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** @@ -5604,7 +5641,7 @@ export namespace compute_alpha { rangeStart?: string | null; } /** - * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==) */ export interface Schema$Interconnect { /** @@ -5709,7 +5746,7 @@ export namespace compute_alpha { state?: string | null; } /** - * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) + * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** @@ -5721,7 +5758,7 @@ export namespace compute_alpha { */ bandwidth?: string | null; /** - * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. + * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. */ candidateSubnets?: string[] | null; /** @@ -5893,7 +5930,7 @@ export namespace compute_alpha { */ export interface Schema$InterconnectAttachmentPartnerMetadata { /** - * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. + * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values. */ interconnectName?: string | null; /** @@ -5901,7 +5938,7 @@ export namespace compute_alpha { */ partnerName?: string | null; /** - * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. + * URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string | null; } @@ -5946,7 +5983,7 @@ export namespace compute_alpha { googleDemarcId?: string | null; } /** - * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. + * Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection. */ export interface Schema$InterconnectDiagnostics { /** @@ -5977,11 +6014,11 @@ export namespace compute_alpha { } export interface Schema$InterconnectDiagnosticsLinkLACPStatus { /** - * System ID of the port on Google?s side of the LACP exchange. + * System ID of the port on Google's side of the LACP exchange. */ googleSystemId?: string | null; /** - * System ID of the port on the neighbor?s side of the LACP exchange. + * System ID of the port on the neighbor's side of the LACP exchange. */ neighborSystemId?: string | null; /** @@ -6329,7 +6366,7 @@ export namespace compute_alpha { */ issuer?: string | null; /** - * The provider?s public key set to validate the signature of the JWT. + * The provider's public key set to validate the signature of the JWT. */ jwksPublicKeys?: string | null; /** @@ -6449,7 +6486,7 @@ export namespace compute_alpha { selfLink?: string | null; } /** - * Commitment for a particular license resource (a License Commitment is composed of one or more of these). + * Commitment for a particular license resource. */ export interface Schema$LicenseResourceCommitment { /** @@ -6585,7 +6622,7 @@ export namespace compute_alpha { logMode?: string | null; } /** - * Machine image resource. + * Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images. (== resource_for {$api_version}.machineImages ==) */ export interface Schema$MachineImage { /** @@ -6683,7 +6720,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) + * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for {$api_version}.machineTypes ==) */ export interface Schema$MachineType { /** @@ -6980,7 +7017,7 @@ export namespace compute_alpha { port?: number | null; } /** - * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) + * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.networks ==) */ export interface Schema$Network { /** @@ -6991,10 +7028,6 @@ export namespace compute_alpha { * [Output Only] Creation timestamp in RFC3339 text format. */ creationTimestamp?: string | null; - /** - * [Output Only] Type of VM-to-VM traffic encryption for this network. - */ - crossVmEncryption?: string | null; /** * An optional description of this resource. Provide this field when you create the resource. */ @@ -7015,10 +7048,6 @@ export namespace compute_alpha { * [Output Only] Type of the resource. Always compute#network for networks. */ kind?: string | null; - /** - * [Output Only] Type of LB-to-VM traffic encryption for this network. - */ - loadBalancerVmEncryption?: string | null; /** * Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1500 bytes. */ @@ -7078,7 +7107,7 @@ export namespace compute_alpha { port?: number | null; } /** - * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) Next ID: 21 + * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21 */ export interface Schema$NetworkEndpointGroup { /** @@ -7214,7 +7243,7 @@ export namespace compute_alpha { */ export interface Schema$NetworkEndpointGroupCloudFunction { /** - * A user-defined name of the Cloud Function. The service name must be 1-63 characters long, and comply with RFC1035. Example value: "func1". + * A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: "func1". */ function?: string | null; /** @@ -7227,7 +7256,7 @@ export namespace compute_alpha { */ export interface Schema$NetworkEndpointGroupCloudRun { /** - * Cloud Run service is the main resource of Cloud Run. The tag must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". + * Cloud Run service is the main resource of Cloud Run. The service must be 1-63 characters long, and comply with RFC1035. Example value: "run-service". */ service?: string | null; /** @@ -7560,7 +7589,7 @@ export namespace compute_alpha { networkPeering?: Schema$NetworkPeering; } /** - * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for {$api_version}.nodeGroups ==) */ export interface Schema$NodeGroup { /** @@ -7692,6 +7721,10 @@ export namespace compute_alpha { } | null; } export interface Schema$NodeGroupNode { + /** + * Accelerators for this node. + */ + accelerators?: Schema$AcceleratorConfig[]; /** * Local disk configurations. */ @@ -7774,9 +7807,6 @@ export namespace compute_alpha { message?: string; } | null; } - export interface Schema$NodeGroupsSetAutoscalingPolicyRequest { - autoscalingPolicy?: Schema$NodeGroupAutoscalingPolicy; - } export interface Schema$NodeGroupsSetNodeTemplateRequest { /** * Full or partial URL of the node template resource to be updated for this node group. @@ -7784,9 +7814,10 @@ export namespace compute_alpha { nodeTemplate?: string | null; } /** - * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for {$api_version}.nodeTemplates ==) (== NextID: 18 ==) */ export interface Schema$NodeTemplate { + accelerators?: Schema$AcceleratorConfig[]; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -7928,7 +7959,7 @@ export namespace compute_alpha { } | null; } /** - * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) + * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for {$api_version}.nodeTypes ==) */ export interface Schema$NodeType { /** @@ -8154,7 +8185,7 @@ export namespace compute_alpha { } | null; } /** - * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) + * Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/latest/globalOperations) * [Regional](/compute/docs/reference/rest/latest/regionOperations) * [Zonal](/compute/docs/reference/rest/latest/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) */ export interface Schema$Operation { /** @@ -8669,7 +8700,7 @@ export namespace compute_alpha { */ pathRules?: Schema$PathRule[]; /** - * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. + * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. */ routeRules?: Schema$HttpRouteRule[]; } @@ -8876,7 +8907,7 @@ export namespace compute_alpha { users?: string[] | null; } /** - * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) + * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for {$api_version}.projects ==) */ export interface Schema$Project { /** @@ -9135,7 +9166,7 @@ export namespace compute_alpha { /** * [Output Only] The status of the public delegated prefix. */ - status?: any | null; + status?: string | null; } export interface Schema$PublicDelegatedPrefixAggregatedList { /** @@ -9242,7 +9273,7 @@ export namespace compute_alpha { /** * [Output Only] The status of the sub public delegated prefix. */ - status?: any | null; + status?: string | null; } /** * A quotas entry. @@ -9301,7 +9332,7 @@ export namespace compute_alpha { target?: string | null; } /** - * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) + * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for {$api_version}.regions ==) */ export interface Schema$Region { /** @@ -9384,7 +9415,7 @@ export namespace compute_alpha { } export interface Schema$RegionCommitmentsUpdateReservationsRequest { /** - * List of two reservations to transfer GPUs and local SSD between. + * A list of two reservations to transfer GPUs and local SSD between. */ reservations?: Schema$Reservation[]; } @@ -9763,7 +9794,7 @@ export namespace compute_alpha { backendService?: string | null; } /** - * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) + * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==) */ export interface Schema$Reservation { /** @@ -10167,7 +10198,7 @@ export namespace compute_alpha { */ export interface Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties { /** - * Indication to perform a ?guest aware? snapshot. + * Indication to perform a 'guest aware' snapshot. */ guestFlush?: boolean | null; /** @@ -10222,7 +10253,7 @@ export namespace compute_alpha { startTime?: string | null; } /** - * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) + * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==) */ export interface Schema$Route { /** @@ -10464,7 +10495,7 @@ export namespace compute_alpha { */ asn?: number | null; /** - * The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer?s hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 1 and 120. The default is 20. + * The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 1 and 120. The default is 20. */ keepaliveInterval?: number | null; } @@ -10961,6 +10992,19 @@ export namespace compute_alpha { */ values?: string[] | null; } + /** + * An instance's screenshot. + */ + export interface Schema$Screenshot { + /** + * [Output Only] The Base64-encoded screenshot data. + */ + contents?: string | null; + /** + * [Output Only] Type of the resource. Always compute#screenshot for the screenshots. + */ + kind?: string | null; + } /** * The configuration to access the SDS server. */ @@ -10977,11 +11021,11 @@ export namespace compute_alpha { wafRules?: Schema$PreconfiguredWafSet; } /** - * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** - * A list of assocations that belong to this policy. + * A list of associations that belong to this policy. */ associations?: Schema$SecurityPolicyAssociation[]; cloudArmorConfig?: Schema$SecurityPolicyCloudArmorConfig; @@ -10993,6 +11037,10 @@ export namespace compute_alpha { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * User-provided name of the Organization security plicy. The name should be unique in the organization in which the security policy is created. This should only be used when SecurityPolicyType is FIREWALL. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + displayName?: string | null; /** * Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. */ @@ -11017,6 +11065,10 @@ export namespace compute_alpha { * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * [Output Only] The parent of the security policy. + */ + parent?: string | null; /** * A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. */ @@ -11043,6 +11095,10 @@ export namespace compute_alpha { * The resource that the security policy is attached to. */ attachmentId?: string | null; + /** + * [Output Only] The display name of the security policy of the association. + */ + displayName?: string | null; /** * The name for an association. */ @@ -11115,7 +11171,7 @@ export namespace compute_alpha { */ kind?: string | null; /** - * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. + * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. */ match?: Schema$SecurityPolicyRuleMatcher; /** @@ -11135,9 +11191,13 @@ export namespace compute_alpha { */ ruleTupleCount?: number | null; /** - * A list of network resource URLs to which this rule applies. This field allows you to control which network?s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL. + * A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. This field may only be specified when versioned_expr is set to FIREWALL. */ targetResources?: string[] | null; + /** + * A list of service accounts indicating the sets of instances that are applied with this rule. + */ + targetServiceAccounts?: string[] | null; } /** * Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. @@ -11165,6 +11225,10 @@ export namespace compute_alpha { * Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL. */ destPorts?: Schema$SecurityPolicyRuleMatcherConfigDestinationPort[]; + /** + * Pairs of IP protocols and ports that the rule should match. This field may only be specified when versioned_expr is set to FIREWALL. + */ + layer4Configs?: Schema$SecurityPolicyRuleMatcherConfigLayer4Config[]; /** * CIDR IP address range. */ @@ -11180,6 +11244,16 @@ export namespace compute_alpha { */ ports?: string[] | null; } + export interface Schema$SecurityPolicyRuleMatcherConfigLayer4Config { + /** + * The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + */ + ipProtocol?: string | null; + /** + * An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. This field may only be specified when versioned_expr is set to FIREWALL. + */ + ports?: string[] | null; + } export interface Schema$SecurityPolicyRuleRateLimitOptions { /** * Can only be specifed if the action for the rule is "rate_based_blacklist" If specified, determines the time (in seconds) the traffic will continue to be blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds. @@ -11403,7 +11477,7 @@ export namespace compute_alpha { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==) */ export interface Schema$Snapshot { /** @@ -11606,7 +11680,7 @@ export namespace compute_alpha { tags?: Schema$Tags; } /** - * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) (== resource_for beta.regionSslCertificates ==) (== resource_for v1.regionSslCertificates ==) Next ID: 17 + * Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/latest/sslCertificates) * [Regional](/compute/docs/reference/rest/latest/regionSslCertificates) - sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers - regionSslCertificates are used by: - internal HTTPS load balancers This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==) Next ID: 17 */ export interface Schema$SslCertificate { /** @@ -11837,7 +11911,7 @@ export namespace compute_alpha { features?: string[] | null; } /** - * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==) */ export interface Schema$SslPolicy { /** @@ -11928,7 +12002,7 @@ export namespace compute_alpha { autoDelete?: string | null; } /** - * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) + * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.subnetworks ==) */ export interface Schema$Subnetwork { /** @@ -12008,7 +12082,7 @@ export namespace compute_alpha { */ privateIpv6GoogleAccess?: string | null; /** - * The service accounts can be used to selectively turn on Private IPv6 Google Access only on the VMs primary service account matching the value. This value only takes effect when PrivateIpv6GoogleAccess is ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS or ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS. + * Deprecated in favor of enable PrivateIpv6GoogleAccess on instance directly. The service accounts can be used to selectively turn on Private IPv6 Google Access only on the VMs primary service account matching the value. This value only takes effect when PrivateIpv6GoogleAccess is ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS or ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS. */ privateIpv6GoogleAccessServiceAccounts?: string[] | null; /** @@ -12208,7 +12282,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of GCP HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) (== resource_for beta.regionTargetHttpProxies ==) (== resource_for v1.regionTargetHttpProxies ==) + * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/latest/targetHttpProxies) * [Regional](/compute/docs/reference/rest/latest/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -12342,7 +12416,7 @@ export namespace compute_alpha { sslCertificates?: string[] | null; } /** - * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of GCP HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) (== resource_for beta.regionTargetHttpsProxies ==) (== resource_for v1.regionTargetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/latest/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/latest/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -12462,7 +12536,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -12493,6 +12567,10 @@ export namespace compute_alpha { * NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported. */ natPolicy?: string | null; + /** + * The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. + */ + network?: string | null; /** * [Output Only] Server-defined URL for the resource. */ @@ -12584,7 +12662,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==) */ export interface Schema$TargetPool { /** @@ -12770,7 +12848,7 @@ export namespace compute_alpha { sslCertificates?: string[] | null; } /** - * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) + * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -12860,7 +12938,7 @@ export namespace compute_alpha { proxyHeader?: string | null; } /** - * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for {$api_version}.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -12930,7 +13008,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -13186,7 +13264,24 @@ export namespace compute_alpha { response?: string | null; } /** - * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. + * Upcoming Maintenance notification information. + */ + export interface Schema$UpcomingMaintenance { + /** + * [Output Only] The date when the maintenance will take place. This value is in RFC3339 text format. + */ + date?: string | null; + /** + * [Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. + */ + time?: string | null; + /** + * Defines the type of maintenance. + */ + type?: string | null; + } + /** + * Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/docs/reference/rest/latest/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts. */ export interface Schema$UrlMap { /** @@ -13745,7 +13840,7 @@ export namespace compute_alpha { ipAddress?: string | null; } /** - * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) + * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for {$api_version}.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -14003,7 +14098,7 @@ export namespace compute_alpha { type?: string | null; } /** - * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) + * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for {$api_version}.zones ==) */ export interface Schema$Zone { /** @@ -24740,7 +24835,7 @@ export namespace compute_alpha { /** * compute.globalOperations.wait - * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.globalOperations.wait * @memberOf! () * @@ -25156,7 +25251,7 @@ export namespace compute_alpha { /** * compute.globalOrganizationOperations.wait - * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.globalOrganizationOperations.wait * @memberOf! () * @@ -33648,6 +33743,82 @@ export namespace compute_alpha { } } + /** + * compute.instances.getScreenshot + * @desc Returns the screenshot from the specified instance. + * @alias compute.instances.getScreenshot + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Name of the instance scoping this request. + * @param {string} params.project Project ID for this request. + * @param {string} params.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 + */ + getScreenshot( + params?: Params$Resource$Instances$Getscreenshot, + options?: MethodOptions + ): GaxiosPromise; + getScreenshot( + params: Params$Resource$Instances$Getscreenshot, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getScreenshot( + params: Params$Resource$Instances$Getscreenshot, + callback: BodyResponseCallback + ): void; + getScreenshot(callback: BodyResponseCallback): void; + getScreenshot( + paramsOrCallback?: + | Params$Resource$Instances$Getscreenshot + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Getscreenshot; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Getscreenshot; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/zones/{zone}/instances/{instance}/screenshot' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instance'], + pathParams: ['instance', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.instances.getSerialPortOutput * @desc Returns the last 1 MB of serial port output from the specified instance. @@ -36714,6 +36885,26 @@ export namespace compute_alpha { */ zone?: string; } + export interface Params$Resource$Instances$Getscreenshot + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the instance scoping this request. + */ + instance?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } export interface Params$Resource$Instances$Getserialportoutput extends StandardParameters { /** @@ -46140,86 +46331,6 @@ export namespace compute_alpha { } } - /** - * compute.nodeGroups.setAutoscalingPolicy - * @desc Sets the autoscaling policy of the node group. - * @alias compute.nodeGroups.setAutoscalingPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.nodeGroup Name of the NodeGroup resource to update. - * @param {string} params.project Project ID for this request. - * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone for this request. - * @param {().NodeGroupsSetAutoscalingPolicyRequest} params.requestBody Request 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 - */ - setAutoscalingPolicy( - params?: Params$Resource$Nodegroups$Setautoscalingpolicy, - options?: MethodOptions - ): GaxiosPromise; - setAutoscalingPolicy( - params: Params$Resource$Nodegroups$Setautoscalingpolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setAutoscalingPolicy( - params: Params$Resource$Nodegroups$Setautoscalingpolicy, - callback: BodyResponseCallback - ): void; - setAutoscalingPolicy( - callback: BodyResponseCallback - ): void; - setAutoscalingPolicy( - paramsOrCallback?: - | Params$Resource$Nodegroups$Setautoscalingpolicy - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Nodegroups$Setautoscalingpolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Nodegroups$Setautoscalingpolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/alpha/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setAutoscalingPolicy' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'nodeGroup'], - pathParams: ['nodeGroup', 'project', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - /** * compute.nodeGroups.setIamPolicy * @desc Sets the access control policy on the specified resource. Replaces any existing policy. @@ -46736,35 +46847,6 @@ export namespace compute_alpha { */ requestBody?: Schema$NodeGroup; } - export interface Params$Resource$Nodegroups$Setautoscalingpolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name of the NodeGroup resource to update. - */ - nodeGroup?: string; - /** - * Project ID for this request. - */ - project?: string; - /** - * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - */ - requestId?: string; - /** - * The name of the zone for this request. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$NodeGroupsSetAutoscalingPolicyRequest; - } export interface Params$Resource$Nodegroups$Setiampolicy extends StandardParameters { /** @@ -54739,7 +54821,7 @@ export namespace compute_alpha { /** * compute.regionCommitments.updateReservations - * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. + * @desc Transfers GPUs or local SSDs between reservations within commitments. * @alias compute.regionCommitments.updateReservations * @memberOf! () * @@ -57510,6 +57592,84 @@ export namespace compute_alpha { } } + /** + * compute.regionHealthCheckServices.patch + * @desc Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @alias compute.regionHealthCheckServices.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheckService Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HealthCheckService} params.requestBody Request 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$Regionhealthcheckservices$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionhealthcheckservices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionhealthcheckservices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/alpha/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.regionHealthCheckServices.testIamPermissions * @desc Returns permissions that a caller has on the specified resource. @@ -57693,6 +57853,35 @@ export namespace compute_alpha { */ region?: string; } + export interface Params$Resource$Regionhealthcheckservices$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheckService; + } export interface Params$Resource$Regionhealthcheckservices$Testiampermissions extends StandardParameters { /** @@ -61920,7 +62109,7 @@ export namespace compute_alpha { /** * compute.regionOperations.wait - * @desc Waits for the specified region-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.regionOperations.wait * @memberOf! () * @@ -81970,7 +82159,7 @@ export namespace compute_alpha { /** * compute.zoneOperations.wait - * @desc Waits for the specified zone-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.zoneOperations.wait * @memberOf! () * diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index be5e6144ba..7a827c7358 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -99,6 +99,7 @@ export namespace compute_beta { forwardingRules: Resource$Forwardingrules; globalAddresses: Resource$Globaladdresses; globalForwardingRules: Resource$Globalforwardingrules; + globalNetworkEndpointGroups: Resource$Globalnetworkendpointgroups; globalOperations: Resource$Globaloperations; healthChecks: Resource$Healthchecks; httpHealthChecks: Resource$Httphealthchecks; @@ -128,8 +129,10 @@ export namespace compute_beta { regionDisks: Resource$Regiondisks; regionDiskTypes: Resource$Regiondisktypes; regionHealthChecks: Resource$Regionhealthchecks; + regionHealthCheckServices: Resource$Regionhealthcheckservices; regionInstanceGroupManagers: Resource$Regioninstancegroupmanagers; regionInstanceGroups: Resource$Regioninstancegroups; + regionNotificationEndpoints: Resource$Regionnotificationendpoints; regionOperations: Resource$Regionoperations; regions: Resource$Regions; regionSslCertificates: Resource$Regionsslcertificates; @@ -178,6 +181,9 @@ export namespace compute_beta { this.globalForwardingRules = new Resource$Globalforwardingrules( this.context ); + this.globalNetworkEndpointGroups = new Resource$Globalnetworkendpointgroups( + this.context + ); this.globalOperations = new Resource$Globaloperations(this.context); this.healthChecks = new Resource$Healthchecks(this.context); this.httpHealthChecks = new Resource$Httphealthchecks(this.context); @@ -217,12 +223,18 @@ export namespace compute_beta { this.regionDisks = new Resource$Regiondisks(this.context); this.regionDiskTypes = new Resource$Regiondisktypes(this.context); this.regionHealthChecks = new Resource$Regionhealthchecks(this.context); + this.regionHealthCheckServices = new Resource$Regionhealthcheckservices( + this.context + ); this.regionInstanceGroupManagers = new Resource$Regioninstancegroupmanagers( this.context ); this.regionInstanceGroups = new Resource$Regioninstancegroups( this.context ); + this.regionNotificationEndpoints = new Resource$Regionnotificationendpoints( + this.context + ); this.regionOperations = new Resource$Regionoperations(this.context); this.regions = new Resource$Regions(this.context); this.regionSslCertificates = new Resource$Regionsslcertificates( @@ -273,7 +285,7 @@ export namespace compute_beta { acceleratorType?: string | null; } /** - * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) + * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for {$api_version}.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -424,7 +436,7 @@ export namespace compute_beta { type?: string | null; } /** - * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) + * Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier. Use global internal addresses for reserved peering network range. Use regional external addresses for the following resources: - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA) Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes: - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses For more information, read reserved IP address. (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==) */ export interface Schema$Address { /** @@ -662,6 +674,10 @@ export namespace compute_beta { * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * The size of the disk in GB. + */ + diskSizeGb?: string | null; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ @@ -786,7 +802,7 @@ export namespace compute_beta { permissionType?: string | null; } /** - * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * [Global](/compute/docs/reference/rest/latest/autoscalers) * [Regional](/compute/docs/reference/rest/latest/regionAutoscalers) Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** @@ -961,6 +977,7 @@ export namespace compute_beta { * Defines operating mode for this policy. */ mode?: string | null; + scaleDownControl?: Schema$AutoscalingPolicyScaleDownControl; } /** * CPU utilization policy. @@ -1005,6 +1022,19 @@ export namespace compute_beta { */ utilizationTarget?: number | null; } + /** + * Configuration that allows for slower scale down so that even if Autoscaler recommends an abrupt scale down of a MIG, it will be throttled as specified by the parameters below. + */ + export interface Schema$AutoscalingPolicyScaleDownControl { + /** + * Maximum allowed number (or %) of VMs that can be deducted from the peak recommendation during the window autoscaler looks at when computing recommendations. Possibly all these VMs can be deleted at once so user service needs to be prepared to lose that many VMs in one step. + */ + maxScaledDownReplicas?: Schema$FixedOrPercent; + /** + * How long back autoscaling should look when computing recommendations to include directives regarding slower scale down, as described above. + */ + timeWindow?: Schema$GoogleDuration; + } /** * Message containing information of one individual backend. */ @@ -1146,7 +1176,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Backend Service resource. A backend service contains configuration values for Google Cloud Platform load balancing services. For more information, read Backend Services. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * Represents a Backend Service resource. A backend service contains configuration values for Google Cloud Platform load balancing services. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](/compute/docs/reference/rest/latest/backendServices) * [Regional](/compute/docs/reference/rest/latest/regionBackendServices) For more information, read Backend Services. (== resource_for {$api_version}.backendService ==) */ export interface Schema$BackendService { /** @@ -1195,7 +1225,7 @@ export namespace compute_beta { */ fingerprint?: string | null; /** - * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. + * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified. Health check is optional for Compute Engine backend services if there is no backend. A health check must not be specified when adding Internet Network Endpoint Group or Serverless Network Endpoint Group as backends. In all other cases, a health check is required for Compute Engine backend services. For internal load balancing, a URL to a HealthCheck resource must be specified instead. */ healthChecks?: string[] | null; iap?: Schema$BackendServiceIAP; @@ -1329,6 +1359,10 @@ export namespace compute_beta { failoverRatio?: number | null; } export interface Schema$BackendServiceGroupHealth { + /** + * Metadata defined as annotations on the network endpoint group. + */ + annotations?: {[key: string]: string} | null; /** * Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks. */ @@ -1551,7 +1585,7 @@ export namespace compute_beta { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,`alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -1621,7 +1655,7 @@ export namespace compute_beta { maxRetries?: number | null; } /** - * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) + * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==) */ export interface Schema$Commitment { /** @@ -1863,7 +1897,7 @@ export namespace compute_beta { */ exposeHeaders?: string[] | null; /** - * Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. + * Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header. */ maxAge?: number | null; } @@ -1928,7 +1962,7 @@ export namespace compute_beta { state?: string | null; } /** - * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) + * Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Global](/compute/docs/reference/rest/latest/disks) * [Regional](/compute/docs/reference/rest/latest/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==) */ export interface Schema$Disk { /** @@ -2187,7 +2221,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) + * Represents a Disk Type resource. Google Compute Engine has two Disk Type resources: * [Global](/compute/docs/reference/rest/latest/diskTypes) * [Regional](/compute/docs/reference/rest/latest/regionDiskTypes) You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for {$api_version}.diskTypes ==) (== resource_for {$api_version}.regionDiskTypes ==) */ export interface Schema$DiskType { /** @@ -2399,28 +2433,28 @@ export namespace compute_beta { } | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } /** - * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. + * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. */ export interface Schema$ExternalVpnGateway { /** @@ -2473,7 +2507,7 @@ export namespace compute_beta { */ id?: number | null; /** - * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider?s VPN gateway, it cannot be an IP address from Google Compute Engine. + * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. */ ipAddress?: string | null; } @@ -2637,6 +2671,10 @@ export namespace compute_beta { * This field denotes whether to enable logging for a particular firewall rule. */ enable?: boolean | null; + /** + * This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs. + */ + metadata?: string | null; } /** * Encapsulates numeric value that can be either absolute or relative. @@ -2656,7 +2694,7 @@ export namespace compute_beta { percent?: number | null; } /** - * Represents a Forwarding Rule resource. A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * Represents a Forwarding Rule resource. Forwarding rule resources in GCP can be either regional or global in scope: * [Global](/compute/docs/reference/rest/latest/globalForwardingRules) * [Regional](/compute/docs/reference/rest/latest/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding. (== resource_for {$api_version}.forwardingRules ==) (== resource_for {$api_version}.globalForwardingRules ==) (== resource_for {$api_version}.regionForwardingRules ==) */ export interface Schema$ForwardingRule { /** @@ -2716,7 +2754,7 @@ export namespace compute_beta { */ labels?: {[key: string]: string} | null; /** - * Specifies the forwarding rule type. EXTERNAL is used for: - Classic Cloud VPN gateways - Protocol forwarding to VMs from an external IP address - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP. INTERNAL is used for: - Protocol forwarding to VMs from an internal IP address - Internal TCP/UDP load balancers INTERNAL_MANAGED is used for: - Internal HTTP(S) load balancers INTERNAL_SELF_MANAGED is used for: - Traffic Director For more information about forwarding rules, refer to Forwarding rule concepts. + * Specifies the forwarding rule type. - EXTERNAL is used for: - Classic Cloud VPN gateways - Protocol forwarding to VMs from an external IP address - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP - INTERNAL is used for: - Protocol forwarding to VMs from an internal IP address - Internal TCP/UDP load balancers - INTERNAL_MANAGED is used for: - Internal HTTP(S) load balancers - >INTERNAL_SELF_MANAGED is used for: - Traffic Director For more information about forwarding rules, refer to Forwarding rule concepts. */ loadBalancingScheme?: string | null; /** @@ -2764,7 +2802,7 @@ export namespace compute_beta { */ subnetwork?: string | null; /** - * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. + * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only targetHttpProxy is valid, not targetHttpsProxy. */ target?: string | null; } @@ -2848,6 +2886,18 @@ export namespace compute_beta { message?: string; } | null; } + 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 detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. @@ -2872,6 +2922,19 @@ export namespace compute_beta { */ policy?: Schema$Policy; } + /** + * A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years. # Examples Example 1: Compute Duration from two Timestamps in pseudo code. Timestamp start = ...; Timestamp end = ...; Duration duration = ...; duration.seconds = end.seconds - start.seconds; duration.nanos = end.nanos - start.nanos; if (duration.seconds 0) { duration.seconds += 1; duration.nanos -= 1000000000; } else if (duration.seconds > 0 && duration.nanos < 0) { duration.seconds -= 1; duration.nanos += 1000000000; } Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. Timestamp start = ...; Duration duration = ...; Timestamp end = ...; end.seconds = start.seconds + duration.seconds; end.nanos = start.nanos + duration.nanos; if (end.nanos = 1000000000) { end.seconds += 1; end.nanos -= 1000000000; } Example 3: Compute Duration from datetime.timedelta in Python. td = datetime.timedelta(days=3, minutes=10) duration = Duration() duration.FromTimedelta(td) # JSON Mapping In JSON format, the Duration type is encoded as a string rather than an object, where the string ends in the suffix "s" (indicating seconds) and is preceded by the number of seconds, with nanoseconds expressed as fractional seconds. For example, 3 seconds with 0 nanoseconds should be encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should be expressed in JSON format as "3.000000001s", and 3 seconds and 1 microsecond should be expressed in JSON format as "3.000001s". + */ + export interface Schema$GoogleDuration { + /** + * Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive. + */ + nanos?: number | null; + /** + * Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + */ + seconds?: string | null; + } /** * A guest attributes entry. */ @@ -2934,7 +2997,7 @@ export namespace compute_beta { type?: string | null; } /** - * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. + * Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/latest/healthChecks) * [Regional](/compute/docs/reference/rest/latest/regionHealthChecks) Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. */ export interface Schema$HealthCheck { /** @@ -2964,6 +3027,10 @@ export namespace compute_beta { * Type of the resource. */ kind?: string | null; + /** + * Configure logging on this health check. + */ + logConfig?: Schema$HealthCheckLogConfig; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ @@ -3024,6 +3091,15 @@ export namespace compute_beta { message?: string; } | null; } + /** + * Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. + */ + export interface Schema$HealthCheckLogConfig { + /** + * Indicates whether or not to export logs. This is false by default, which means no health check logging will be done. + */ + enable?: boolean | null; + } /** * A full or valid partial URL to a health check. For example, the following are valid URLs: - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check - projects/project-id/global/httpHealthChecks/health-check - global/httpHealthChecks/health-check */ @@ -3060,6 +3136,93 @@ export namespace compute_beta { message?: string; } | null; } + /** + * A HealthCheckService defines a set of backends on which to perform periodic health checks and an endpoint to which to send notification of changes in the health status of the backends. + */ + export interface Schema$HealthCheckService { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. + */ + fingerprint?: string | null; + /** + * List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification=USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs. + */ + healthChecks?: string[] | null; + /** + * Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. . + */ + healthStatusAggregationPolicy?: string | null; + /** + * Policy for how the results from multiple health checks for the same endpoint are aggregated. - NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service. - AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. . + */ + healthStatusAggregationStrategy?: any | null; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. + */ + kind?: string | null; + /** + * Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * List of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. + */ + networkEndpointGroups?: string[] | null; + /** + * List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. + */ + notificationEndpoints?: string[] | null; + /** + * [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + } + export interface Schema$HealthCheckServicesList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of HealthCheckService resources. + */ + items?: Schema$HealthCheckService[]; + /** + * [Output Only] Type of the resource. Always compute#healthCheckServicesList for lists of HealthCheckServices. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } export interface Schema$HealthChecksScopedList { /** * A list of HealthChecks contained in this scope. @@ -3075,6 +3238,10 @@ export namespace compute_beta { } | null; } export interface Schema$HealthStatus { + /** + * Metadata defined as annotations for network endpoint. + */ + annotations?: {[key: string]: string} | null; /** * Health state of the instance. */ @@ -3084,11 +3251,11 @@ export namespace compute_beta { */ instance?: string | null; /** - * The IP address represented by this resource. + * A forwarding rule IP address assigned to this instance. */ ipAddress?: string | null; /** - * The port on the instance. + * The named port of the instance group, not necessarily the port that is health-checked. */ port?: number | null; } @@ -3242,11 +3409,11 @@ export namespace compute_beta { */ presentMatch?: boolean | null; /** - * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. */ rangeMatch?: Schema$Int64RangeMatch; /** - * The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; /** @@ -3408,7 +3575,7 @@ export namespace compute_beta { */ presentMatch?: boolean | null; /** - * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; } @@ -3425,11 +3592,11 @@ export namespace compute_beta { */ httpsRedirect?: boolean | null; /** - * The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters. + * The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. */ pathRedirect?: string | null; /** - * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. + * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. */ prefixRedirect?: string | null; /** @@ -3547,7 +3714,7 @@ export namespace compute_beta { */ queryParameterMatches?: Schema$HttpQueryParameterMatch[]; /** - * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; } @@ -3672,7 +3839,7 @@ export namespace compute_beta { } | null; } /** - * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) + * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==) */ export interface Schema$Image { /** @@ -3830,7 +3997,7 @@ export namespace compute_beta { } | null; } /** - * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) + * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==) */ export interface Schema$Instance { /** @@ -3913,6 +4080,10 @@ export namespace compute_beta { * Specifies the reservations that this instance can consume from. */ reservationAffinity?: Schema$ReservationAffinity; + /** + * Resource policies applied to this instance. + */ + resourcePolicies?: string[] | null; /** * Sets the scheduling options for this instance. */ @@ -3989,7 +4160,7 @@ export namespace compute_beta { } | null; } /** - * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -4109,7 +4280,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) + * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** @@ -4197,7 +4368,7 @@ export namespace compute_beta { */ targetPools?: string[] | null; /** - * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. + * The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. */ targetSize?: number | null; /** @@ -4486,6 +4657,10 @@ export namespace compute_beta { targetPools?: string[] | null; } export interface Schema$InstanceGroupManagerStatus { + /** + * [Output Only] The URL of the Autoscaler that targets this instance group manager. + */ + autoscaler?: string | null; /** * [Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified. */ @@ -4889,7 +5064,7 @@ export namespace compute_beta { disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; } /** - * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) + * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** @@ -4990,7 +5165,7 @@ export namespace compute_beta { rangeStart?: string | null; } /** - * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==) */ export interface Schema$Interconnect { /** @@ -5091,7 +5266,7 @@ export namespace compute_beta { state?: string | null; } /** - * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) + * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** @@ -5103,7 +5278,7 @@ export namespace compute_beta { */ bandwidth?: string | null; /** - * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. + * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. */ candidateSubnets?: string[] | null; /** @@ -5267,7 +5442,7 @@ export namespace compute_beta { */ export interface Schema$InterconnectAttachmentPartnerMetadata { /** - * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. + * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values. */ interconnectName?: string | null; /** @@ -5275,7 +5450,7 @@ export namespace compute_beta { */ partnerName?: string | null; /** - * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. + * URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string | null; } @@ -5320,7 +5495,7 @@ export namespace compute_beta { googleDemarcId?: string | null; } /** - * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. + * Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection. */ export interface Schema$InterconnectDiagnostics { /** @@ -5351,11 +5526,11 @@ export namespace compute_beta { } export interface Schema$InterconnectDiagnosticsLinkLACPStatus { /** - * System ID of the port on Google?s side of the LACP exchange. + * System ID of the port on Google's side of the LACP exchange. */ googleSystemId?: string | null; /** - * System ID of the port on the neighbor?s side of the LACP exchange. + * System ID of the port on the neighbor's side of the LACP exchange. */ neighborSystemId?: string | null; /** @@ -5783,7 +5958,7 @@ export namespace compute_beta { logMode?: string | null; } /** - * Machine image resource. + * Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images. (== resource_for {$api_version}.machineImages ==) */ export interface Schema$MachineImage { /** @@ -5877,7 +6052,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) + * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for {$api_version}.machineTypes ==) */ export interface Schema$MachineType { /** @@ -6136,7 +6311,7 @@ export namespace compute_beta { port?: number | null; } /** - * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) + * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.networks ==) */ export interface Schema$Network { /** @@ -6192,6 +6367,14 @@ export namespace compute_beta { * The network endpoint. Next ID: 7 */ export interface Schema$NetworkEndpoint { + /** + * Metadata defined as annotations on the network endpoint. + */ + annotations?: {[key: string]: string} | null; + /** + * Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. + */ + fqdn?: string | null; /** * The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group. The name must be 1-63 characters long, and comply with RFC1035. */ @@ -6206,9 +6389,13 @@ export namespace compute_beta { port?: number | null; } /** - * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) Next ID: 21 + * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21 */ export interface Schema$NetworkEndpointGroup { + /** + * Metadata defined as annotations on the network endpoint group. + */ + annotations?: {[key: string]: string} | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -6501,10 +6688,18 @@ export namespace compute_beta { * Whether to export the custom routes to peer network. */ exportCustomRoutes?: boolean | null; + /** + * Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. + */ + exportSubnetRoutesWithPublicIp?: boolean | null; /** * Whether to import the custom routes from peer network. */ importCustomRoutes?: boolean | null; + /** + * Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. + */ + importSubnetRoutesWithPublicIp?: boolean | null; /** * Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ @@ -6559,7 +6754,7 @@ export namespace compute_beta { networkPeering?: Schema$NetworkPeering; } /** - * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for {$api_version}.nodeGroups ==) */ export interface Schema$NodeGroup { /** @@ -6772,7 +6967,7 @@ export namespace compute_beta { nodeTemplate?: string | null; } /** - * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for {$api_version}.nodeTemplates ==) (== NextID: 18 ==) */ export interface Schema$NodeTemplate { /** @@ -6911,7 +7106,7 @@ export namespace compute_beta { } | null; } /** - * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) + * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for {$api_version}.nodeTypes ==) */ export interface Schema$NodeType { /** @@ -7041,7 +7236,99 @@ export namespace compute_beta { } | null; } /** - * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) + * A notification endpoint resource defines an endpoint to receive notifications when there are status changes detected by the associated health check service. + */ + export interface Schema$NotificationEndpoint { + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Settings of the gRPC notification endpoint including the endpoint URL and the retry duration. + */ + grpcSettings?: Schema$NotificationEndpointGrpcSettings; + /** + * [Output Only] A unique identifier for this resource type. The server generates this identifier. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. + */ + kind?: string | null; + /** + * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + } + /** + * Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. + */ + export interface Schema$NotificationEndpointGrpcSettings { + /** + * Optional. If specified, this field is used to set the authority header by the sender of notifications. See https://tools.ietf.org/html/rfc7540#section-8.1.2.3 + */ + authority?: string | null; + /** + * Endpoint to which gRPC notifications are sent. This must be a valid gRPCLB DNS name. + */ + endpoint?: string | null; + /** + * Optional. If specified, this field is used to populate the "name" field in gRPC requests. + */ + payloadName?: string | null; + /** + * Optional. This field is used to configure how often to send a full update of all non-healthy backends. If unspecified, full updates are not sent. If specified, must be in the range between 600 seconds to 3600 seconds. Nanos are disallowed. + */ + resendInterval?: Schema$Duration; + /** + * How much time (in seconds) is spent attempting notification retries until a successful response is received. Default is 30s. Limit is 20m (1200s). Must be a positive number. + */ + retryDurationSec?: number | null; + } + export interface Schema$NotificationEndpointList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of NotificationEndpoint resources. + */ + items?: Schema$NotificationEndpoint[]; + /** + * [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + /** + * Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/latest/globalOperations) * [Regional](/compute/docs/reference/rest/latest/regionOperations) * [Zonal](/compute/docs/reference/rest/latest/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) */ export interface Schema$Operation { /** @@ -7532,7 +7819,7 @@ export namespace compute_beta { */ pathRules?: Schema$PathRule[]; /** - * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. + * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. */ routeRules?: Schema$HttpRouteRule[]; } @@ -7631,7 +7918,7 @@ export namespace compute_beta { source?: string | null; } /** - * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) + * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for {$api_version}.projects ==) */ export interface Schema$Project { /** @@ -7768,7 +8055,7 @@ export namespace compute_beta { target?: string | null; } /** - * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) + * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for {$api_version}.regions ==) */ export interface Schema$Region { /** @@ -7847,7 +8134,7 @@ export namespace compute_beta { } export interface Schema$RegionCommitmentsUpdateReservationsRequest { /** - * List of two reservations to transfer GPUs and local SSD between. + * A list of two reservations to transfer GPUs and local SSD between. */ reservations?: Schema$Reservation[]; } @@ -8222,7 +8509,7 @@ export namespace compute_beta { backendService?: string | null; } /** - * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) + * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==) */ export interface Schema$Reservation { /** @@ -8413,6 +8700,10 @@ export namespace compute_beta { */ creationTimestamp?: string | null; description?: string | null; + /** + * Resource policy for instacnes for placement configuration. + */ + groupPlacementPolicy?: Schema$ResourcePolicyGroupPlacementPolicy; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ @@ -8490,6 +8781,23 @@ export namespace compute_beta { */ startTime?: string | null; } + /** + * A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality + */ + export interface Schema$ResourcePolicyGroupPlacementPolicy { + /** + * The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network + */ + availabilityDomainCount?: number | null; + /** + * Specifies network collocation + */ + collocation?: string | null; + /** + * Number of vms in this placement group + */ + vmCount?: number | null; + } /** * Time window specified for hourly operations. */ @@ -8581,7 +8889,7 @@ export namespace compute_beta { */ export interface Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties { /** - * Indication to perform a ?guest aware? snapshot. + * Indication to perform a 'guest aware' snapshot. */ guestFlush?: boolean | null; /** @@ -8617,7 +8925,7 @@ export namespace compute_beta { startTime?: string | null; } /** - * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) + * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==) */ export interface Schema$Route { /** @@ -8851,7 +9159,7 @@ export namespace compute_beta { */ asn?: number | null; /** - * The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer?s hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 1 and 120. The default is 20. + * The interval in seconds between BGP keepalive messages that are sent to the peer. Hold time is three times the interval at which keepalive messages are sent, and the hold time is the maximum number of seconds allowed to elapse between successive keepalive messages that BGP receives from a peer. BGP will use the smaller of either the local hold time value or the peer's hold time value as the hold time for the BGP connection between the two peers. If set, this value must be between 1 and 120. The default is 20. */ keepaliveInterval?: number | null; } @@ -9335,7 +9643,7 @@ export namespace compute_beta { wafRules?: Schema$PreconfiguredWafSet; } /** - * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -9425,7 +9733,7 @@ export namespace compute_beta { */ kind?: string | null; /** - * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. + * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. */ match?: Schema$SecurityPolicyRuleMatcher; /** @@ -9627,7 +9935,7 @@ export namespace compute_beta { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==) */ export interface Schema$Snapshot { /** @@ -9646,6 +9954,10 @@ export namespace compute_beta { * [Output Only] Size of the source disk, specified in GB. */ diskSizeGb?: string | null; + /** + * [Output Only] Number of bytes downloaded to restore a snapshot to a disk. + */ + downloadBytes?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ @@ -9818,7 +10130,7 @@ export namespace compute_beta { tags?: Schema$Tags; } /** - * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) (== resource_for beta.regionSslCertificates ==) (== resource_for v1.regionSslCertificates ==) Next ID: 17 + * Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/latest/sslCertificates) * [Regional](/compute/docs/reference/rest/latest/regionSslCertificates) - sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers - regionSslCertificates are used by: - internal HTTPS load balancers This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==) Next ID: 17 */ export interface Schema$SslCertificate { /** @@ -10045,7 +10357,7 @@ export namespace compute_beta { features?: string[] | null; } /** - * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==) */ export interface Schema$SslPolicy { /** @@ -10128,7 +10440,7 @@ export namespace compute_beta { autoDelete?: string | null; } /** - * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) + * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.subnetworks ==) */ export interface Schema$Subnetwork { /** @@ -10192,7 +10504,7 @@ export namespace compute_beta { */ privateIpv6GoogleAccess?: string | null; /** - * The service accounts can be used to selectively turn on Private IPv6 Google Access only on the VMs primary service account matching the value. This value only takes effect when PrivateIpv6GoogleAccess is ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS or ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS. + * Deprecated in favor of enable PrivateIpv6GoogleAccess on instance directly. The service accounts can be used to selectively turn on Private IPv6 Google Access only on the VMs primary service account matching the value. This value only takes effect when PrivateIpv6GoogleAccess is ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS or ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE_FOR_SERVICE_ACCOUNTS. */ privateIpv6GoogleAccessServiceAccounts?: string[] | null; /** @@ -10368,7 +10680,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of GCP HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) (== resource_for beta.regionTargetHttpProxies ==) (== resource_for v1.regionTargetHttpProxies ==) + * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/latest/targetHttpProxies) * [Regional](/compute/docs/reference/rest/latest/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -10494,7 +10806,7 @@ export namespace compute_beta { sslCertificates?: string[] | null; } /** - * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of GCP HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) (== resource_for beta.regionTargetHttpsProxies ==) (== resource_for v1.regionTargetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/latest/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/latest/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -10606,7 +10918,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -10724,7 +11036,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==) */ export interface Schema$TargetPool { /** @@ -10906,7 +11218,7 @@ export namespace compute_beta { sslCertificates?: string[] | null; } /** - * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) + * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -10996,7 +11308,7 @@ export namespace compute_beta { proxyHeader?: string | null; } /** - * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for {$api_version}.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -11066,7 +11378,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -11244,7 +11556,7 @@ export namespace compute_beta { permissions?: string[] | null; } /** - * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. + * Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/docs/reference/rest/latest/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts. */ export interface Schema$UrlMap { /** @@ -11795,7 +12107,7 @@ export namespace compute_beta { ipAddress?: string | null; } /** - * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) + * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for {$api_version}.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -12053,7 +12365,7 @@ export namespace compute_beta { type?: string | null; } /** - * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) + * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for {$api_version}.zones ==) */ export interface Schema$Zone { /** @@ -12232,6 +12544,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -12600,6 +12913,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -12747,6 +13064,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -13649,6 +13967,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -13895,6 +14217,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -14936,6 +15259,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -16432,6 +16759,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -17834,6 +18162,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -18233,6 +18565,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -19664,6 +19997,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -20052,6 +20389,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -20410,6 +20748,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -22236,6 +22578,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -23366,6 +23709,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -25720,6 +26067,750 @@ export namespace compute_beta { 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.requestBody Request 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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.requestBody Request 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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.requestBody Request 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + 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< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$NetworkEndpointGroupsListNetworkEndpoints + >, + 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://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/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 { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -25797,6 +26888,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -26263,7 +27355,7 @@ export namespace compute_beta { /** * compute.globalOperations.wait - * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.globalOperations.wait * @memberOf! () * @@ -26348,6 +27440,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -26456,6 +27552,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -27477,6 +28574,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -31475,6 +32576,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -34301,6 +35403,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -35165,6 +36271,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -36405,6 +37512,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -36867,6 +37978,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -41608,6 +42720,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -43754,6 +44870,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -44704,6 +45821,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -47866,6 +48987,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -48231,6 +49353,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -48314,6 +49440,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -49063,6 +50190,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -51025,6 +52156,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -51991,6 +53123,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -52322,6 +53458,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -52951,6 +54088,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -53158,6 +54299,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -53394,6 +54536,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -53476,6 +54622,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -54035,6 +55182,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -58665,6 +59816,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -59152,7 +60304,7 @@ export namespace compute_beta { /** * compute.regionCommitments.updateReservations - * @desc Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments. + * @desc Transfers GPUs or local SSDs between reservations within commitments. * @alias compute.regionCommitments.updateReservations * @memberOf! () * @@ -59240,6 +60392,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -61466,6 +62622,533 @@ export namespace compute_beta { requestBody?: Schema$HealthCheck; } + export class Resource$Regionhealthcheckservices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionHealthCheckServices.delete + * @desc Deletes the specified regional HealthCheckService. + * @alias compute.regionHealthCheckServices.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheckService Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Regionhealthcheckservices$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionhealthcheckservices$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionhealthcheckservices$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthCheckServices.get + * @desc Returns the specified regional HealthCheckService resource. + * @alias compute.regionHealthCheckServices.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheckService Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionhealthcheckservices$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionhealthcheckservices$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionhealthcheckservices$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthCheckServices.insert + * @desc Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. + * @alias compute.regionHealthCheckServices.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HealthCheckService} params.requestBody Request 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$Regionhealthcheckservices$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionhealthcheckservices$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionhealthcheckservices$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/healthCheckServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthCheckServices.list + * @desc Lists all the HealthCheckService resources that have been configured for the specified project in the given region. + * @alias compute.regionHealthCheckServices.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionhealthcheckservices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionhealthcheckservices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionhealthcheckservices$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/healthCheckServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionHealthCheckServices.patch + * @desc Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + * @alias compute.regionHealthCheckServices.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.healthCheckService Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().HealthCheckService} params.requestBody Request 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$Regionhealthcheckservices$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Regionhealthcheckservices$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Regionhealthcheckservices$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Regionhealthcheckservices$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionhealthcheckservices$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionhealthcheckservices$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'healthCheckService'], + pathParams: ['healthCheckService', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionhealthcheckservices$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheckService to delete. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionhealthcheckservices$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthcheckservices$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheckService; + } + export interface Params$Resource$Regionhealthcheckservices$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionhealthcheckservices$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the HealthCheckService to update. The name must be 1-63 characters long, and comply with RFC1035. + */ + healthCheckService?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HealthCheckService; + } + export class Resource$Regioninstancegroupmanagers { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -65700,6 +67383,428 @@ export namespace compute_beta { requestBody?: Schema$TestPermissionsRequest; } + export class Resource$Regionnotificationendpoints { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.regionNotificationEndpoints.delete + * @desc Deletes the specified NotificationEndpoint in the given region + * @alias compute.regionNotificationEndpoints.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.notificationEndpoint Name of the NotificationEndpoint resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [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$Regionnotificationendpoints$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Regionnotificationendpoints$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Regionnotificationendpoints$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'notificationEndpoint'], + pathParams: ['notificationEndpoint', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNotificationEndpoints.get + * @desc Returns the specified NotificationEndpoint resource in the given region. + * @alias compute.regionNotificationEndpoints.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.notificationEndpoint Name of the NotificationEndpoint resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Regionnotificationendpoints$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Regionnotificationendpoints$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Regionnotificationendpoints$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'notificationEndpoint'], + pathParams: ['notificationEndpoint', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNotificationEndpoints.insert + * @desc Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. + * @alias compute.regionNotificationEndpoints.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().NotificationEndpoint} params.requestBody Request 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$Regionnotificationendpoints$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Regionnotificationendpoints$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Regionnotificationendpoints$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/notificationEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.regionNotificationEndpoints.list + * @desc Lists the NotificationEndpoints for a project in the given region. + * @alias compute.regionNotificationEndpoints.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Regionnotificationendpoints$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Regionnotificationendpoints$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Regionnotificationendpoints$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Regionnotificationendpoints$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnotificationendpoints$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionnotificationendpoints$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/notificationEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Regionnotificationendpoints$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NotificationEndpoint resource to delete. + */ + notificationEndpoint?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Regionnotificationendpoints$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the NotificationEndpoint resource to return. + */ + notificationEndpoint?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export interface Params$Resource$Regionnotificationendpoints$Insert + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NotificationEndpoint; + } + export interface Params$Resource$Regionnotificationendpoints$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + } + export class Resource$Regionoperations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -66112,7 +68217,7 @@ export namespace compute_beta { /** * compute.regionOperations.wait - * @desc Waits for the specified region-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.regionOperations.wait * @memberOf! () * @@ -69028,6 +71133,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -69734,6 +71840,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -69969,6 +72079,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -70600,6 +72711,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -70870,6 +72985,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -72274,6 +74390,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -75869,6 +77989,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -76625,6 +78746,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -77544,6 +79669,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -79084,6 +81210,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -79408,6 +81538,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -80298,6 +82429,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -80461,6 +82596,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -81641,6 +83777,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -81942,6 +84082,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -82718,6 +84859,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -83215,6 +85360,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -84598,6 +86744,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -87230,6 +89380,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -88086,6 +90237,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -88273,6 +90428,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -89553,6 +91709,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -89780,6 +91940,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -90336,6 +92497,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -90579,6 +92744,7 @@ export namespace compute_beta { * * @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 {boolean=} params.includeAllScopes Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. * @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. @@ -91425,6 +93591,10 @@ export namespace compute_beta { * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). */ filter?: string; + /** + * Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. + */ + includeAllScopes?: boolean; /** * 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) */ @@ -92008,7 +94178,7 @@ export namespace compute_beta { /** * compute.zoneOperations.wait - * @desc Waits for the specified zone-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.zoneOperations.wait * @memberOf! () * diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index b5009d0b7a..0595a72132 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -119,6 +119,7 @@ export namespace compute_v1 { nodeGroups: Resource$Nodegroups; nodeTemplates: Resource$Nodetemplates; nodeTypes: Resource$Nodetypes; + packetMirrorings: Resource$Packetmirrorings; projects: Resource$Projects; regionAutoscalers: Resource$Regionautoscalers; regionBackendServices: Resource$Regionbackendservices; @@ -204,6 +205,7 @@ export namespace compute_v1 { this.nodeGroups = new Resource$Nodegroups(this.context); this.nodeTemplates = new Resource$Nodetemplates(this.context); this.nodeTypes = new Resource$Nodetypes(this.context); + this.packetMirrorings = new Resource$Packetmirrorings(this.context); this.projects = new Resource$Projects(this.context); this.regionAutoscalers = new Resource$Regionautoscalers(this.context); this.regionBackendServices = new Resource$Regionbackendservices( @@ -269,7 +271,7 @@ export namespace compute_v1 { acceleratorType?: string | null; } /** - * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for beta.acceleratorTypes ==) (== resource_for v1.acceleratorTypes ==) + * Represents an Accelerator Type resource. Google Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for {$api_version}.acceleratorTypes ==) */ export interface Schema$AcceleratorType { /** @@ -420,7 +422,7 @@ export namespace compute_v1 { type?: string | null; } /** - * Represents an IP Address resource. An address resource represents a regional internal IP address. Regional internal IP addresses are RFC 1918 addresses that come from either a primary or secondary IP range of a subnet in a VPC network. Regional external IP addresses can be assigned to GCP VM instances, Cloud VPN gateways, regional external forwarding rules for network load balancers (in either Standard or Premium Tier), and regional external forwarding rules for HTTP(S), SSL Proxy, and TCP Proxy load balancers in Standard Tier. For more information, read IP addresses. A globalAddresses resource represent a global external IP address. Global external IP addresses are IPv4 or IPv6 addresses. They can only be assigned to global forwarding rules for HTTP(S), SSL Proxy, or TCP Proxy load balancers in Premium Tier. For more information, read Global resources. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==) + * Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier. Use global internal addresses for reserved peering network range. Use regional external addresses for the following resources: - External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA) Use regional internal IP addresses for subnet IP ranges (primary and secondary). This includes: - Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses For more information, read reserved IP address. (== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==) */ export interface Schema$Address { /** @@ -650,6 +652,10 @@ export namespace compute_v1 { * Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. */ diskEncryptionKey?: Schema$CustomerEncryptionKey; + /** + * The size of the disk in GB. + */ + diskSizeGb?: string | null; /** * A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. */ @@ -770,7 +776,7 @@ export namespace compute_v1 { permissionType?: string | null; } /** - * Represents an Autoscaler resource. Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for beta.autoscalers ==) (== resource_for v1.autoscalers ==) (== resource_for beta.regionAutoscalers ==) (== resource_for v1.regionAutoscalers ==) + * Represents an Autoscaler resource. Google Compute Engine has two Autoscaler resources: * [Global](/compute/docs/reference/rest/latest/autoscalers) * [Regional](/compute/docs/reference/rest/latest/regionAutoscalers) Use autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances. For zonal managed instance groups resource, use the autoscaler resource. For regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==) */ export interface Schema$Autoscaler { /** @@ -1118,7 +1124,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Backend Service resource. A backend service contains configuration values for Google Cloud Platform load balancing services. For more information, read Backend Services. (== resource_for v1.backendService ==) (== resource_for beta.backendService ==) + * Represents a Backend Service resource. A backend service contains configuration values for Google Cloud Platform load balancing services. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](/compute/docs/reference/rest/latest/backendServices) * [Regional](/compute/docs/reference/rest/latest/regionBackendServices) For more information, read Backend Services. (== resource_for {$api_version}.backendService ==) */ export interface Schema$BackendService { /** @@ -1163,7 +1169,7 @@ export namespace compute_v1 { */ fingerprint?: string | null; /** - * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified, and a health check is required for Compute Engine backend services. A health check must not be specified for App Engine backend and Cloud Function backend. For internal load balancing, a URL to a HealthCheck resource must be specified instead. + * The list of URLs to the HttpHealthCheck or HttpsHealthCheck resource for health checking this BackendService. Currently at most one health check can be specified. Health check is optional for Compute Engine backend services if there is no backend. A health check must not be specified when adding Internet Network Endpoint Group or Serverless Network Endpoint Group as backends. In all other cases, a health check is required for Compute Engine backend services. For internal load balancing, a URL to a HealthCheck resource must be specified instead. */ healthChecks?: string[] | null; iap?: Schema$BackendServiceIAP; @@ -1183,10 +1189,18 @@ export namespace compute_v1 { * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to >MAGLEV or RING_HASH, session affinity settings will not take effect. */ localityLbPolicy?: string | null; + /** + * This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver. + */ + logConfig?: Schema$BackendServiceLogConfig; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL. + */ + network?: string | null; /** * Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled. This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. */ @@ -1329,6 +1343,19 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * The available logging options for the load balancer traffic served by this backend service. + */ + export interface Schema$BackendServiceLogConfig { + /** + * This field denotes whether to enable logging for the load balancer traffic served by this backend service. + */ + enable?: boolean | null; + /** + * This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0. + */ + sampleRate?: number | null; + } export interface Schema$BackendServiceReference { backendService?: string | null; } @@ -1355,7 +1382,7 @@ export namespace compute_v1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,`alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -1421,7 +1448,7 @@ export namespace compute_v1 { maxRetries?: number | null; } /** - * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==) + * Represents a regional Commitment resource. Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==) */ export interface Schema$Commitment { /** @@ -1659,7 +1686,7 @@ export namespace compute_v1 { */ exposeHeaders?: string[] | null; /** - * Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header. + * Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header. */ maxAge?: number | null; } @@ -1716,7 +1743,7 @@ export namespace compute_v1 { state?: string | null; } /** - * Represents a Persistent Disk resource. Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for beta.disks ==) (== resource_for v1.disks ==) (== resource_for v1.regionDisks ==) (== resource_for beta.regionDisks ==) + * Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * [Global](/compute/docs/reference/rest/latest/disks) * [Regional](/compute/docs/reference/rest/latest/regionDisks) Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==) */ export interface Schema$Disk { /** @@ -1967,7 +1994,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Disk Type resource. You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for beta.diskTypes ==) (== resource_for v1.diskTypes ==) (== resource_for v1.regionDiskTypes ==) (== resource_for beta.regionDiskTypes ==) + * Represents a Disk Type resource. Google Compute Engine has two Disk Type resources: * [Global](/compute/docs/reference/rest/latest/diskTypes) * [Regional](/compute/docs/reference/rest/latest/regionDiskTypes) You can choose from a variety of disk types based on your needs. For more information, read Storage options. The diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks. The regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for {$api_version}.diskTypes ==) (== resource_for {$api_version}.regionDiskTypes ==) */ export interface Schema$DiskType { /** @@ -2179,28 +2206,28 @@ export namespace compute_v1 { } | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } /** - * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider?s VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. + * External VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway. To create a highly available VPN from Google Cloud to your on-premises side or another Cloud provider's VPN gateway, you must create a external VPN gateway resource in GCP, which provides the information to GCP about your external VPN gateway. */ export interface Schema$ExternalVpnGateway { /** @@ -2253,7 +2280,7 @@ export namespace compute_v1 { */ id?: number | null; /** - * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider?s VPN gateway, it cannot be an IP address from Google Compute Engine. + * IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine. */ ipAddress?: string | null; } @@ -2432,9 +2459,13 @@ export namespace compute_v1 { percent?: number | null; } /** - * Represents a Forwarding Rule resource. A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding. (== resource_for beta.forwardingRules ==) (== resource_for v1.forwardingRules ==) (== resource_for beta.globalForwardingRules ==) (== resource_for v1.globalForwardingRules ==) (== resource_for beta.regionForwardingRules ==) (== resource_for v1.regionForwardingRules ==) + * Represents a Forwarding Rule resource. Forwarding rule resources in GCP can be either regional or global in scope: * [Global](/compute/docs/reference/rest/latest/globalForwardingRules) * [Regional](/compute/docs/reference/rest/latest/forwardingRules) A forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway). For more information, read Forwarding rule concepts and Using protocol forwarding. (== resource_for {$api_version}.forwardingRules ==) (== resource_for {$api_version}.globalForwardingRules ==) (== resource_for {$api_version}.regionForwardingRules ==) */ export interface Schema$ForwardingRule { + /** + * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer. + */ + allowGlobalAccess?: boolean | null; /** * This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields. When the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule. */ @@ -2451,6 +2482,10 @@ export namespace compute_v1 { * An optional description of this resource. Provide this property when you create the resource. */ description?: string | null; + /** + * Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. + */ + fingerprint?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ @@ -2467,12 +2502,16 @@ export namespace compute_v1 { * The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule. */ ipVersion?: string | null; + /** + * Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. + */ + isMirroringCollector?: boolean | null; /** * [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. */ kind?: string | null; /** - * Specifies the forwarding rule type. EXTERNAL is used for: - Classic Cloud VPN gateways - Protocol forwarding to VMs from an external IP address - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP. INTERNAL is used for: - Protocol forwarding to VMs from an internal IP address - Internal TCP/UDP load balancers INTERNAL_MANAGED is used for: - Internal HTTP(S) load balancers INTERNAL_SELF_MANAGED is used for: - Traffic Director For more information about forwarding rules, refer to Forwarding rule concepts. + * Specifies the forwarding rule type. - EXTERNAL is used for: - Classic Cloud VPN gateways - Protocol forwarding to VMs from an external IP address - The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP - INTERNAL is used for: - Protocol forwarding to VMs from an internal IP address - Internal TCP/UDP load balancers - INTERNAL_MANAGED is used for: - Internal HTTP(S) load balancers - >INTERNAL_SELF_MANAGED is used for: - Traffic Director For more information about forwarding rules, refer to Forwarding rule concepts. */ loadBalancingScheme?: string | null; /** @@ -2520,7 +2559,7 @@ export namespace compute_v1 { */ subnetwork?: string | null; /** - * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only HTTP and HTTPS targets are valid. + * The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only targetHttpProxy is valid, not targetHttpsProxy. */ target?: string | null; } @@ -2690,7 +2729,7 @@ export namespace compute_v1 { type?: string | null; } /** - * Represents a Health Check resource. Health checks are used for most GCP load balancers and managed instance group auto-healing. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. + * Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/latest/healthChecks) * [Regional](/compute/docs/reference/rest/latest/regionHealthChecks) Internal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts. To perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks. */ export interface Schema$HealthCheck { /** @@ -2840,11 +2879,11 @@ export namespace compute_v1 { */ instance?: string | null; /** - * The IP address represented by this resource. + * A forwarding rule IP address assigned to this instance. */ ipAddress?: string | null; /** - * The port on the instance. + * The named port of the instance group, not necessarily the port that is health-checked. */ port?: number | null; } @@ -2998,11 +3037,11 @@ export namespace compute_v1 { */ presentMatch?: boolean | null; /** - * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. */ rangeMatch?: Schema$Int64RangeMatch; /** - * The value of the header must match the regualar expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. + * The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript For matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; /** @@ -3164,7 +3203,7 @@ export namespace compute_v1 { */ presentMatch?: boolean | null; /** - * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. + * The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; } @@ -3181,11 +3220,11 @@ export namespace compute_v1 { */ httpsRedirect?: boolean | null; /** - * The path that will be used in the redirect response instead of the one that was supplied in the request. Only one of pathRedirect or prefixRedirect must be specified. The value must be between 1 and 1024 characters. + * The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. */ pathRedirect?: string | null; /** - * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. + * The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters. */ prefixRedirect?: string | null; /** @@ -3303,7 +3342,7 @@ export namespace compute_v1 { */ queryParameterMatches?: Schema$HttpQueryParameterMatch[]; /** - * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. + * For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. */ regexMatch?: string | null; } @@ -3428,7 +3467,7 @@ export namespace compute_v1 { } | null; } /** - * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for beta.images ==) (== resource_for v1.images ==) + * Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==) */ export interface Schema$Image { /** @@ -3586,7 +3625,7 @@ export namespace compute_v1 { } | null; } /** - * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for beta.instances ==) (== resource_for v1.instances ==) + * Represents an Instance resource. An instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==) */ export interface Schema$Instance { /** @@ -3731,7 +3770,7 @@ export namespace compute_v1 { } | null; } /** - * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for beta.instanceGroups ==) (== resource_for v1.instanceGroups ==) (== resource_for beta.regionInstanceGroups ==) (== resource_for v1.regionInstanceGroups ==) + * Represents an Instance Group resource. Instance Groups can be used to configure a target for load balancing. Instance groups can either be managed or unmanaged. To create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead. Use zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups. For more information, read Instance groups. (== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==) */ export interface Schema$InstanceGroup { /** @@ -3851,7 +3890,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for beta.instanceGroupManagers ==) (== resource_for v1.instanceGroupManagers ==) (== resource_for beta.regionInstanceGroupManagers ==) (== resource_for v1.regionInstanceGroupManagers ==) + * Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==) */ export interface Schema$InstanceGroupManager { /** @@ -3923,7 +3962,7 @@ export namespace compute_v1 { */ targetPools?: string[] | null; /** - * The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number. + * The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. */ targetSize?: number | null; /** @@ -4056,6 +4095,23 @@ export namespace compute_v1 { */ instances?: string[] | null; } + /** + * InstanceGroupManagers.applyUpdatesToInstances + */ + export interface Schema$InstanceGroupManagersApplyUpdatesRequest { + /** + * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + /** + * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. + */ + minimalAction?: string | null; + /** + * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. + */ + mostDisruptiveAllowedAction?: string | null; + } /** * InstanceGroupManagers.createInstances */ @@ -4430,7 +4486,7 @@ export namespace compute_v1 { disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; } /** - * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for beta.instanceTemplates ==) (== resource_for v1.instanceTemplates ==) + * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==) */ export interface Schema$InstanceTemplate { /** @@ -4531,7 +4587,7 @@ export namespace compute_v1 { rangeStart?: string | null; } /** - * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==) + * Represents an Interconnect resource. An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==) */ export interface Schema$Interconnect { /** @@ -4624,7 +4680,7 @@ export namespace compute_v1 { state?: string | null; } /** - * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for beta.interconnectAttachments ==) (== resource_for v1.interconnectAttachments ==) + * Represents an Interconnect Attachment (VLAN) resource. You can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==) */ export interface Schema$InterconnectAttachment { /** @@ -4636,7 +4692,7 @@ export namespace compute_v1 { */ bandwidth?: string | null; /** - * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google?s edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. + * Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. */ candidateSubnets?: string[] | null; /** @@ -4792,7 +4848,7 @@ export namespace compute_v1 { */ export interface Schema$InterconnectAttachmentPartnerMetadata { /** - * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner?s portal. For instance "Chicago 1". This value may be validated to match approved Partner values. + * Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance "Chicago 1". This value may be validated to match approved Partner values. */ interconnectName?: string | null; /** @@ -4800,7 +4856,7 @@ export namespace compute_v1 { */ partnerName?: string | null; /** - * URL of the Partner?s portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. + * URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values. */ portalUrl?: string | null; } @@ -4845,7 +4901,7 @@ export namespace compute_v1 { googleDemarcId?: string | null; } /** - * Diagnostics information about interconnect, contains detailed and current technical information about Google?s side of the connection. + * Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection. */ export interface Schema$InterconnectDiagnostics { /** @@ -4876,11 +4932,11 @@ export namespace compute_v1 { } export interface Schema$InterconnectDiagnosticsLinkLACPStatus { /** - * System ID of the port on Google?s side of the LACP exchange. + * System ID of the port on Google's side of the LACP exchange. */ googleSystemId?: string | null; /** - * System ID of the port on the neighbor?s side of the LACP exchange. + * System ID of the port on the neighbor's side of the LACP exchange. */ neighborSystemId?: string | null; /** @@ -5308,7 +5364,7 @@ export namespace compute_v1 { logMode?: string | null; } /** - * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==) + * Represents a Machine Type resource. You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for {$api_version}.machineTypes ==) */ export interface Schema$MachineType { /** @@ -5465,6 +5521,10 @@ export namespace compute_v1 { * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. */ instance?: string | null; + /** + * [Output Only] Health state of the instance per health-check. + */ + instanceHealth?: Schema$ManagedInstanceInstanceHealth[]; /** * [Output Only] The status of the instance. This field is empty when the instance does not exist. */ @@ -5478,6 +5538,16 @@ export namespace compute_v1 { */ version?: Schema$ManagedInstanceVersion; } + export interface Schema$ManagedInstanceInstanceHealth { + /** + * [Output Only] The current detailed instance health state. + */ + detailedHealthState?: string | null; + /** + * [Output Only] The URL for the health check that verifies whether the instance is healthy. + */ + healthCheck?: string | null; + } export interface Schema$ManagedInstanceLastAttempt { /** * [Output Only] Encountered errors during the last attempt to create or delete the instance. @@ -5553,7 +5623,7 @@ export namespace compute_v1 { port?: number | null; } /** - * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) + * Represents a VPC Network resource. Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.networks ==) */ export interface Schema$Network { /** @@ -5623,7 +5693,7 @@ export namespace compute_v1 { port?: number | null; } /** - * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for v1.networkEndpointGroups ==) (== resource_for beta.networkEndpointGroups ==) Next ID: 21 + * Represents a collection of network endpoints. For more information read Setting up network endpoint groups in load balancing. (== resource_for {$api_version}.networkEndpointGroups ==) Next ID: 21 */ export interface Schema$NetworkEndpointGroup { /** @@ -5947,7 +6017,7 @@ export namespace compute_v1 { networkPeering?: Schema$NetworkPeering; } /** - * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) + * Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for {$api_version}.nodeGroups ==) */ export interface Schema$NodeGroup { /** @@ -6133,7 +6203,7 @@ export namespace compute_v1 { nodeTemplate?: string | null; } /** - * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for beta.nodeTemplates ==) (== resource_for v1.nodeTemplates ==) + * Represent a sole-tenant Node Template resource. You can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for {$api_version}.nodeTemplates ==) (== NextID: 18 ==) */ export interface Schema$NodeTemplate { /** @@ -6272,7 +6342,7 @@ export namespace compute_v1 { } | null; } /** - * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) + * Represent a sole-tenant Node Type resource. Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for {$api_version}.nodeTypes ==) */ export interface Schema$NodeType { /** @@ -6402,7 +6472,7 @@ export namespace compute_v1 { } | null; } /** - * Represents an Operation resource. You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) + * Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/latest/globalOperations) * [Regional](/compute/docs/reference/rest/latest/regionOperations) * [Zonal](/compute/docs/reference/rest/latest/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zonalOperations resource. For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==) */ export interface Schema$Operation { /** @@ -6630,6 +6700,207 @@ export namespace compute_v1 { */ successRateStdevFactor?: number | null; } + /** + * Represents a PacketMirroring resource. + */ + export interface Schema$PacketMirroring { + /** + * The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true. + */ + collectorIlb?: Schema$PacketMirroringForwardingRuleInfo; + /** + * [Output Only] Creation timestamp in RFC3339 text format. + */ + creationTimestamp?: string | null; + /** + * An optional description of this resource. Provide this property when you create the resource. + */ + description?: string | null; + /** + * Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. + */ + enable?: string | null; + /** + * Filter for mirrored traffic. If unspecified, all traffic is mirrored. + */ + filter?: Schema$PacketMirroringFilter; + /** + * [Output Only] The unique identifier for the resource. This identifier is defined by the server. + */ + id?: string | null; + /** + * [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. + */ + kind?: string | null; + /** + * PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored. + */ + mirroredResources?: Schema$PacketMirroringMirroredResourceInfo; + /** + * Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network. + */ + network?: Schema$PacketMirroringNetworkInfo; + /** + * The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. + */ + priority?: number | null; + /** + * [Output Only] URI of the region where the packetMirroring resides. + */ + region?: string | null; + /** + * [Output Only] Server-defined URL for the resource. + */ + selfLink?: string | null; + } + /** + * Contains a list of packetMirrorings. + */ + export interface Schema$PacketMirroringAggregatedList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PacketMirroring resources. + */ + items?: {[key: string]: Schema$PacketMirroringsScopedList} | null; + /** + * Type of resource. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$PacketMirroringFilter { + /** + * IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored. + */ + cidrRanges?: string[] | null; + /** + * Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored. + */ + IPProtocols?: string[] | null; + } + export interface Schema$PacketMirroringForwardingRuleInfo { + /** + * [Output Only] Unique identifier for the forwarding rule; defined by the server. + */ + canonicalUrl?: string | null; + /** + * Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic. + */ + url?: string | null; + } + /** + * Contains a list of PacketMirroring resources. + */ + export interface Schema$PacketMirroringList { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of PacketMirroring resources. + */ + items?: Schema$PacketMirroring[]; + /** + * [Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } + export interface Schema$PacketMirroringMirroredResourceInfo { + /** + * A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring. Note that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring. You may specify a maximum of 50 Instances. + */ + instances?: Schema$PacketMirroringMirroredResourceInfoInstanceInfo[]; + /** + * A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring. You may specify a maximum of 5 subnetworks. + */ + subnetworks?: Schema$PacketMirroringMirroredResourceInfoSubnetInfo[]; + /** + * A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored. + */ + tags?: string[] | null; + } + export interface Schema$PacketMirroringMirroredResourceInfoInstanceInfo { + /** + * [Output Only] Unique identifier for the instance; defined by the server. + */ + canonicalUrl?: string | null; + /** + * Resource URL to the virtual machine instance which is being mirrored. + */ + url?: string | null; + } + export interface Schema$PacketMirroringMirroredResourceInfoSubnetInfo { + /** + * [Output Only] Unique identifier for the subnetwork; defined by the server. + */ + canonicalUrl?: string | null; + /** + * Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored. + */ + url?: string | null; + } + export interface Schema$PacketMirroringNetworkInfo { + /** + * [Output Only] Unique identifier for the network; defined by the server. + */ + canonicalUrl?: string | null; + /** + * URL of the network resource. + */ + url?: string | null; + } + export interface Schema$PacketMirroringsScopedList { + /** + * A list of packetMirrorings contained in this scope. + */ + packetMirrorings?: Schema$PacketMirroring[]; + /** + * Informational warning which replaces the list of packetMirrorings when the list is empty. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used. */ @@ -6663,7 +6934,7 @@ export namespace compute_v1 { */ pathRules?: Schema$PathRule[]; /** - * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External Load balancers. + * The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number. Within a given pathMatcher, you can set only one of pathRules or routeRules. */ routeRules?: Schema$HttpRouteRule[]; } @@ -6725,7 +6996,7 @@ export namespace compute_v1 { version?: number | null; } /** - * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for v1.projects ==) (== resource_for beta.projects ==) + * Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for {$api_version}.projects ==) */ export interface Schema$Project { /** @@ -6862,7 +7133,7 @@ export namespace compute_v1 { target?: string | null; } /** - * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==) + * Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for {$api_version}.regions ==) */ export interface Schema$Region { /** @@ -7059,6 +7330,23 @@ export namespace compute_v1 { */ instances?: string[] | null; } + /** + * InstanceGroupManagers.applyUpdatesToInstances + */ + export interface Schema$RegionInstanceGroupManagersApplyUpdatesRequest { + /** + * The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + /** + * The minimal action that you want to perform on each instance during the update: - REPLACE: At minimum, delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update. + */ + minimalAction?: string | null; + /** + * The most disruptive action that you want to perform on each instance during the update: - REPLACE: Delete the instance and create it again. - RESTART: Stop the instance and start it again. - REFRESH: Do not stop the instance. - NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail. + */ + mostDisruptiveAllowedAction?: string | null; + } /** * RegionInstanceGroupManagers.createInstances */ @@ -7231,7 +7519,7 @@ export namespace compute_v1 { backendService?: string | null; } /** - * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) + * Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==) */ export interface Schema$Reservation { /** @@ -7590,7 +7878,7 @@ export namespace compute_v1 { */ export interface Schema$ResourcePolicySnapshotSchedulePolicySnapshotProperties { /** - * Indication to perform a ?guest aware? snapshot. + * Indication to perform a 'guest aware' snapshot. */ guestFlush?: boolean | null; /** @@ -7626,7 +7914,7 @@ export namespace compute_v1 { startTime?: string | null; } /** - * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for beta.routes ==) (== resource_for v1.routes ==) + * Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==) */ export interface Schema$Route { /** @@ -8230,7 +8518,7 @@ export namespace compute_v1 { values?: string[] | null; } /** - * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for v1.securityPolicies ==) (== resource_for beta.securityPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.securityPolicies ==) */ export interface Schema$SecurityPolicy { /** @@ -8312,7 +8600,7 @@ export namespace compute_v1 { */ kind?: string | null; /** - * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. + * A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. */ match?: Schema$SecurityPolicyRuleMatcher; /** @@ -8332,6 +8620,10 @@ export namespace compute_v1 { * The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. */ config?: Schema$SecurityPolicyRuleMatcherConfig; + /** + * User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. + */ + expr?: Schema$Expr; /** * Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. */ @@ -8454,7 +8746,7 @@ export namespace compute_v1 { keyValue?: string | null; } /** - * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==) + * Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==) */ export interface Schema$Snapshot { /** @@ -8473,6 +8765,10 @@ export namespace compute_v1 { * [Output Only] Size of the source disk, specified in GB. */ diskSizeGb?: string | null; + /** + * [Output Only] Number of bytes downloaded to restore a snapshot to a disk. + */ + downloadBytes?: string | null; /** * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ @@ -8581,7 +8877,7 @@ export namespace compute_v1 { diskConfigs?: Schema$DiskInstantiationConfig[]; } /** - * Represents an SSL Certificate resource. This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for beta.sslCertificates ==) (== resource_for v1.sslCertificates ==) (== resource_for beta.regionSslCertificates ==) (== resource_for v1.regionSslCertificates ==) Next ID: 17 + * Represents an SSL Certificate resource. Google Compute Engine has two SSL Certificate resources: * [Global](/compute/docs/reference/rest/latest/sslCertificates) * [Regional](/compute/docs/reference/rest/latest/regionSslCertificates) - sslCertificates are used by: - external HTTPS load balancers - SSL proxy load balancers - regionSslCertificates are used by: - internal HTTPS load balancers This SSL certificate resource also contains a private key. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and Using SSL Certificates. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==) Next ID: 17 */ export interface Schema$SslCertificate { /** @@ -8758,7 +9054,7 @@ export namespace compute_v1 { features?: string[] | null; } /** - * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for beta.sslPolicies ==) (== resource_for v1.sslPolicies ==) + * Represents a Cloud Armor Security Policy resource. Only external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==) */ export interface Schema$SslPolicy { /** @@ -8821,7 +9117,7 @@ export namespace compute_v1 { sslPolicy?: string | null; } /** - * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for beta.subnetworks ==) (== resource_for v1.subnetworks ==) + * Represents a Subnetwork resource. A subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.subnetworks ==) */ export interface Schema$Subnetwork { /** @@ -9045,7 +9341,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Target HTTP Proxy resource. A target HTTP proxy is a component of GCP HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpProxies ==) (== resource_for v1.targetHttpProxies ==) (== resource_for beta.regionTargetHttpProxies ==) (== resource_for v1.regionTargetHttpProxies ==) + * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/latest/targetHttpProxies) * [Regional](/compute/docs/reference/rest/latest/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==) */ export interface Schema$TargetHttpProxy { /** @@ -9163,7 +9459,7 @@ export namespace compute_v1 { sslCertificates?: string[] | null; } /** - * Represents a Target HTTPS Proxy resource. A target HTTPS proxy is a component of GCP HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for beta.targetHttpsProxies ==) (== resource_for v1.targetHttpsProxies ==) (== resource_for beta.regionTargetHttpsProxies ==) (== resource_for v1.regionTargetHttpsProxies ==) + * Represents a Target HTTPS Proxy resource. Google Compute Engine has two Target HTTPS Proxy resources: * [Global](/compute/docs/reference/rest/latest/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/latest/regionTargetHttpsProxies) A target HTTPS proxy is a component of GCP HTTPS load balancers. * targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers. Forwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==) */ export interface Schema$TargetHttpsProxy { /** @@ -9275,7 +9571,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for beta.targetInstances ==) (== resource_for v1.targetInstances ==) + * Represents a Target Instance resource. You can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==) */ export interface Schema$TargetInstance { /** @@ -9393,7 +9689,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for beta.targetPools ==) (== resource_for v1.targetPools ==) + * Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==) */ export interface Schema$TargetPool { /** @@ -9575,7 +9871,7 @@ export namespace compute_v1 { sslCertificates?: string[] | null; } /** - * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for beta.targetSslProxies ==) (== resource_for v1.targetSslProxies ==) + * Represents a Target SSL Proxy resource. A target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==) */ export interface Schema$TargetSslProxy { /** @@ -9665,7 +9961,7 @@ export namespace compute_v1 { proxyHeader?: string | null; } /** - * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for beta.targetTcpProxies ==) (== resource_for v1.targetTcpProxies ==) + * Represents a Target TCP Proxy resource. A target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing Concepts. (== resource_for {$api_version}.targetTcpProxies ==) */ export interface Schema$TargetTcpProxy { /** @@ -9735,7 +10031,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for beta.targetVpnGateways ==) (== resource_for v1.targetVpnGateways ==) + * Represents a Target VPN Gateway resource. The target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==) */ export interface Schema$TargetVpnGateway { /** @@ -9905,7 +10201,7 @@ export namespace compute_v1 { permissions?: string[] | null; } /** - * Represents a URL Map resource. A URL map resource is a component of certain types of load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use this resource, the backend service must have a loadBalancingScheme of either EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED For more information, read URL Map Concepts. + * Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/latest/urlMaps) * [Regional](/compute/docs/reference/rest/latest/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts. */ export interface Schema$UrlMap { /** @@ -10456,7 +10752,7 @@ export namespace compute_v1 { ipAddress?: string | null; } /** - * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for beta.vpnTunnels ==) (== resource_for v1.vpnTunnels ==) + * Represents a Cloud VPN Tunnel resource. For more information about VPN, read the the Cloud VPN Overview. (== resource_for {$api_version}.vpnTunnels ==) */ export interface Schema$VpnTunnel { /** @@ -10686,7 +10982,7 @@ export namespace compute_v1 { type?: string | null; } /** - * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for beta.zones ==) (== resource_for v1.zones ==) + * Represents a Zone resource. A zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for {$api_version}.zones ==) */ export interface Schema$Zone { /** @@ -20550,6 +20846,84 @@ export namespace compute_v1 { } } + /** + * compute.forwardingRules.patch + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. + * @alias compute.forwardingRules.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().ForwardingRule} params.requestBody Request 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$Forwardingrules$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Forwardingrules$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Forwardingrules$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Forwardingrules$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Forwardingrules$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Forwardingrules$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'forwardingRule'], + pathParams: ['forwardingRule', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.forwardingRules.setTarget * @desc Changes target URL for forwarding rule. The new target should be of the same type as the old target. @@ -20818,6 +21192,35 @@ export namespace compute_v1 { */ region?: string; } + export interface Params$Resource$Forwardingrules$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; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ForwardingRule; + } export interface Params$Resource$Forwardingrules$Settarget extends StandardParameters { /** @@ -21997,6 +22400,83 @@ export namespace compute_v1 { } } + /** + * compute.globalForwardingRules.patch + * @desc Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. + * @alias compute.globalForwardingRules.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.forwardingRule Name of the ForwardingRule resource to patch. + * @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 {().ForwardingRule} params.requestBody Request 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$Globalforwardingrules$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Globalforwardingrules$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Globalforwardingrules$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Globalforwardingrules$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Globalforwardingrules$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Globalforwardingrules$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/forwardingRules/{forwardingRule}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'forwardingRule'], + pathParams: ['forwardingRule', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.globalForwardingRules.setTarget * @desc Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. @@ -22217,6 +22697,31 @@ export namespace compute_v1 { */ 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$Settarget extends StandardParameters { /** @@ -22786,7 +23291,7 @@ export namespace compute_v1 { /** * compute.globalOperations.wait - * @desc Waits for the specified Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.globalOperations.wait * @memberOf! () * @@ -27539,38 +28044,39 @@ export namespace compute_v1 { } /** - * compute.instanceGroupManagers.createInstances - * @desc Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. - * @alias compute.instanceGroupManagers.createInstances + * compute.instanceGroupManagers.applyUpdatesToInstances + * @desc Apply changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. + * @alias compute.instanceGroupManagers.applyUpdatesToInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. + * @param {string} params.instanceGroupManager The name of the managed instance group, should conform to RFC1035. * @param {string} params.project Project ID for this request. - * @param {string=} params.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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone where the managed instance group is located. It should conform to RFC1035. - * @param {().InstanceGroupManagersCreateInstancesRequest} params.requestBody Request body data + * @param {string} params.zone The name of the zone where the managed instance group is located. Should conform to RFC1035. + * @param {().InstanceGroupManagersApplyUpdatesRequest} params.requestBody Request 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 */ - createInstances( - params?: Params$Resource$Instancegroupmanagers$Createinstances, + applyUpdatesToInstances( + params?: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, options?: MethodOptions ): GaxiosPromise; - createInstances( - params: Params$Resource$Instancegroupmanagers$Createinstances, + applyUpdatesToInstances( + params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - createInstances( - params: Params$Resource$Instancegroupmanagers$Createinstances, + applyUpdatesToInstances( + params: Params$Resource$Instancegroupmanagers$Applyupdatestoinstances, callback: BodyResponseCallback ): void; - createInstances(callback: BodyResponseCallback): void; - createInstances( + applyUpdatesToInstances( + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Createinstances + | Params$Resource$Instancegroupmanagers$Applyupdatestoinstances | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -27578,12 +28084,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Createinstances; + {}) as Params$Resource$Instancegroupmanagers$Applyupdatestoinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Createinstances; + params = {} as Params$Resource$Instancegroupmanagers$Applyupdatestoinstances; options = {}; } @@ -27598,7 +28104,7 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances' + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -27617,93 +28123,38 @@ export namespace compute_v1 { } /** - * compute.instanceGroupManagers.delete - * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Compute Engine API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/compute - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * var google = require('googleapis'); - * var compute = google.compute('v1'); - * - * authorize(function(authClient) { - * var request = { - * // Project ID for this request. - * project: 'my-project', // TODO: Update placeholder value. - * - * // The name of the zone where the managed instance group is located. - * zone: 'my-zone', // TODO: Update placeholder value. - * - * // The name of the managed instance group to delete. - * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * compute.instanceGroupManagers.delete(request, function(err, response) { - * if (err) { - * console.error(err); - * return; - * } - * - * // TODO: Change code below to process the `response` object: - * console.log(JSON.stringify(response, null, 2)); - * }); - * }); - * - * function authorize(callback) { - * google.auth.getApplicationDefault(function(err, authClient) { - * if (err) { - * console.error('authentication failed: ', err); - * return; - * } - * if (authClient.createScopedRequired && authClient.createScopedRequired()) { - * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; - * authClient = authClient.createScoped(scopes); - * } - * callback(authClient); - * }); - * } - * @alias compute.instanceGroupManagers.delete + * compute.instanceGroupManagers.createInstances + * @desc Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. + * @alias compute.instanceGroupManagers.createInstances * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the managed instance group to delete. + * @param {string} params.instanceGroupManager The name of the managed instance group. It should conform to RFC1035. * @param {string} params.project Project ID for this request. - * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - * @param {string} params.zone The name of the zone where the managed instance group is located. + * @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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the managed instance group is located. It should conform to RFC1035. + * @param {().InstanceGroupManagersCreateInstancesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Instancegroupmanagers$Delete, + createInstances( + params?: Params$Resource$Instancegroupmanagers$Createinstances, options?: MethodOptions ): GaxiosPromise; - delete( - params: Params$Resource$Instancegroupmanagers$Delete, + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Instancegroupmanagers$Delete, + createInstances( + params: Params$Resource$Instancegroupmanagers$Createinstances, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + createInstances(callback: BodyResponseCallback): void; + createInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Delete + | Params$Resource$Instancegroupmanagers$Createinstances | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -27711,12 +28162,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Delete; + {}) as Params$Resource$Instancegroupmanagers$Createinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Delete; + params = {} as Params$Resource$Instancegroupmanagers$Createinstances; options = {}; } @@ -27731,9 +28182,9 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', }, options ), @@ -27750,8 +28201,8 @@ export namespace compute_v1 { } /** - * compute.instanceGroupManagers.deleteInstances - * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * compute.instanceGroupManagers.delete + * @desc Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. * @example * * // BEFORE RUNNING: * // --------------- @@ -27778,17 +28229,13 @@ export namespace compute_v1 { * // The name of the zone where the managed instance group is located. * zone: 'my-zone', // TODO: Update placeholder value. * - * // The name of the managed instance group. + * // The name of the managed instance group to delete. * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. * - * resource: { - * // TODO: Add desired properties to the request body. - * }, - * * auth: authClient, * }; * - * compute.instanceGroupManagers.deleteInstances(request, function(err, response) { + * compute.instanceGroupManagers.delete(request, function(err, response) { * if (err) { * console.error(err); * return; @@ -27812,36 +28259,35 @@ export namespace compute_v1 { * callback(authClient); * }); * } - * @alias compute.instanceGroupManagers.deleteInstances + * @alias compute.instanceGroupManagers.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.instanceGroupManager The name of the managed instance group. + * @param {string} params.instanceGroupManager The name of the managed instance group to delete. * @param {string} params.project Project ID for this request. * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). * @param {string} params.zone The name of the zone where the managed instance group is located. - * @param {().InstanceGroupManagersDeleteInstancesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - deleteInstances( - params?: Params$Resource$Instancegroupmanagers$Deleteinstances, + delete( + params?: Params$Resource$Instancegroupmanagers$Delete, options?: MethodOptions ): GaxiosPromise; - deleteInstances( - params: Params$Resource$Instancegroupmanagers$Deleteinstances, + delete( + params: Params$Resource$Instancegroupmanagers$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - deleteInstances( - params: Params$Resource$Instancegroupmanagers$Deleteinstances, + delete( + params: Params$Resource$Instancegroupmanagers$Delete, callback: BodyResponseCallback ): void; - deleteInstances(callback: BodyResponseCallback): void; - deleteInstances( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Deleteinstances + | Params$Resource$Instancegroupmanagers$Delete | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -27849,12 +28295,12 @@ export namespace compute_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Deleteinstances; + {}) as Params$Resource$Instancegroupmanagers$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Instancegroupmanagers$Deleteinstances; + params = {} as Params$Resource$Instancegroupmanagers$Delete; options = {}; } @@ -27869,9 +28315,9 @@ export namespace compute_v1 { { url: ( rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', }, options ), @@ -27888,8 +28334,146 @@ export namespace compute_v1 { } /** - * compute.instanceGroupManagers.get - * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. + * compute.instanceGroupManagers.deleteInstances + * @desc Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. + * @example + * * // BEFORE RUNNING: + * // --------------- + * // 1. If not already done, enable the Compute Engine API + * // and check the quota for your project at + * // https://console.developers.google.com/apis/api/compute + * // 2. This sample uses Application Default Credentials for authentication. + * // If not already done, install the gcloud CLI from + * // https://cloud.google.com/sdk and run + * // `gcloud beta auth application-default login`. + * // For more information, see + * // https://developers.google.com/identity/protocols/application-default-credentials + * // 3. Install the Node.js client library by running + * // `npm install googleapis --save` + * + * var google = require('googleapis'); + * var compute = google.compute('v1'); + * + * authorize(function(authClient) { + * var request = { + * // Project ID for this request. + * project: 'my-project', // TODO: Update placeholder value. + * + * // The name of the zone where the managed instance group is located. + * zone: 'my-zone', // TODO: Update placeholder value. + * + * // The name of the managed instance group. + * instanceGroupManager: 'my-instance-group-manager', // TODO: Update placeholder value. + * + * resource: { + * // TODO: Add desired properties to the request body. + * }, + * + * auth: authClient, + * }; + * + * compute.instanceGroupManagers.deleteInstances(request, function(err, response) { + * if (err) { + * console.error(err); + * return; + * } + * + * // TODO: Change code below to process the `response` object: + * console.log(JSON.stringify(response, null, 2)); + * }); + * }); + * + * function authorize(callback) { + * google.auth.getApplicationDefault(function(err, authClient) { + * if (err) { + * console.error('authentication failed: ', err); + * return; + * } + * if (authClient.createScopedRequired && authClient.createScopedRequired()) { + * var scopes = ['https://www.googleapis.com/auth/cloud-platform']; + * authClient = authClient.createScoped(scopes); + * } + * callback(authClient); + * }); + * } + * @alias compute.instanceGroupManagers.deleteInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group. + * @param {string} params.project Project ID for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {string} params.zone The name of the zone where the managed instance group is located. + * @param {().InstanceGroupManagersDeleteInstancesRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + deleteInstances( + params?: Params$Resource$Instancegroupmanagers$Deleteinstances, + options?: MethodOptions + ): GaxiosPromise; + deleteInstances( + params: Params$Resource$Instancegroupmanagers$Deleteinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + deleteInstances( + params: Params$Resource$Instancegroupmanagers$Deleteinstances, + callback: BodyResponseCallback + ): void; + deleteInstances(callback: BodyResponseCallback): void; + deleteInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Deleteinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Deleteinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Deleteinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.instanceGroupManagers.get + * @desc Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. * @example * * // BEFORE RUNNING: * // --------------- @@ -29151,6 +29735,31 @@ export namespace compute_v1 { */ project?: string; } + export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group, should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone where the managed instance group is located. Should conform to RFC1035. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersApplyUpdatesRequest; + } export interface Params$Resource$Instancegroupmanagers$Createinstances extends StandardParameters { /** @@ -45307,301 +45916,1039 @@ export namespace compute_v1 { * Project ID for this request. */ project?: string; - /** - * The name of the region for this request. - */ - region?: string; + /** + * The name of the region for this request. + */ + region?: string; + } + export interface Params$Resource$Nodetemplates$Setiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionSetPolicyRequest; + } + export interface Params$Resource$Nodetemplates$Testiampermissions + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region for this request. + */ + region?: string; + /** + * Name or id of the resource for this request. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestPermissionsRequest; + } + + export class Resource$Nodetypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.nodeTypes.aggregatedList + * @desc Retrieves an aggregated list of node types. + * @alias compute.nodeTypes.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Nodetypes$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Nodetypes$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Nodetypes$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodetypes$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/projects/{project}/aggregated/nodeTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTypes.get + * @desc Returns the specified node type. Gets a list of available node types by making a list() request. + * @alias compute.nodeTypes.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.nodeType Name of the node type to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Nodetypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Nodetypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Nodetypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Nodetypes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/zones/{zone}/nodeTypes/{nodeType}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeType'], + pathParams: ['nodeType', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.nodeTypes.list + * @desc Retrieves a list of node types available to the specified project. + * @alias compute.nodeTypes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.zone The name of the zone for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Nodetypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Nodetypes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Nodetypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Nodetypes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodetypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/compute/v1/projects/{project}/zones/{zone}/nodeTypes' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'zone'], + pathParams: ['project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Nodetypes$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + } + export interface Params$Resource$Nodetypes$Get extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Name of the node type to return. + */ + nodeType?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + } + export interface Params$Resource$Nodetypes$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; + /** + * The name of the zone for this request. + */ + zone?: string; + } + + export class Resource$Packetmirrorings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * compute.packetMirrorings.aggregatedList + * @desc Retrieves an aggregated list of packetMirrorings. + * @alias compute.packetMirrorings.aggregatedList + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + aggregatedList( + params?: Params$Resource$Packetmirrorings$Aggregatedlist, + options?: MethodOptions + ): GaxiosPromise; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + aggregatedList( + params: Params$Resource$Packetmirrorings$Aggregatedlist, + callback: BodyResponseCallback + ): void; + aggregatedList( + callback: BodyResponseCallback + ): void; + aggregatedList( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Aggregatedlist + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Aggregatedlist; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Aggregatedlist; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/aggregated/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * compute.packetMirrorings.delete + * @desc Deletes the specified PacketMirroring resource. + * @alias compute.packetMirrorings.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to delete. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Packetmirrorings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Packetmirrorings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Packetmirrorings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.get + * @desc Returns the specified PacketMirroring resource. + * @alias compute.packetMirrorings.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to return. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Packetmirrorings$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Packetmirrorings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Packetmirrorings$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.insert + * @desc Creates a PacketMirroring resource in the specified project and region using the data included in the request. + * @alias compute.packetMirrorings.insert + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().PacketMirroring} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + insert( + params?: Params$Resource$Packetmirrorings$Insert, + options?: MethodOptions + ): GaxiosPromise; + insert( + params: Params$Resource$Packetmirrorings$Insert, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + insert( + params: Params$Resource$Packetmirrorings$Insert, + callback: BodyResponseCallback + ): void; + insert(callback: BodyResponseCallback): void; + insert( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Insert + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Insert; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Insert; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.list + * @desc Retrieves a list of PacketMirroring resources available to the specified project and region. + * @alias compute.packetMirrorings.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Packetmirrorings$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Packetmirrorings$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Packetmirrorings$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/packetMirrorings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.patch + * @desc Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. + * @alias compute.packetMirrorings.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.packetMirroring Name of the PacketMirroring resource to patch. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region for this request. + * @param {string=} params.requestId An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * @param {().PacketMirroring} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + patch( + params?: Params$Resource$Packetmirrorings$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Packetmirrorings$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Packetmirrorings$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['project', 'region', 'packetMirroring'], + pathParams: ['packetMirroring', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * compute.packetMirrorings.testIamPermissions + * @desc Returns permissions that a caller has on the specified resource. + * @alias compute.packetMirrorings.testIamPermissions + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.project Project ID for this request. + * @param {string} params.region The name of the region for this request. + * @param {string} params.resource_ Name or id of the resource for this request. + * @param {().TestPermissionsRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + testIamPermissions( + params?: Params$Resource$Packetmirrorings$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Packetmirrorings$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Packetmirrorings$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Packetmirrorings$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Packetmirrorings$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'resource'], + pathParams: ['project', 'region', 'resource'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Packetmirrorings$Aggregatedlist + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; } - export interface Params$Resource$Nodetemplates$Setiampolicy + export interface Params$Resource$Packetmirrorings$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Name of the PacketMirroring resource to delete. + */ + packetMirroring?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; /** - * Name or id of the resource for this request. - */ - resource?: string; - - /** - * Request body metadata + * 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). */ - requestBody?: Schema$RegionSetPolicyRequest; + requestId?: string; } - export interface Params$Resource$Nodetemplates$Testiampermissions + export interface Params$Resource$Packetmirrorings$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * Name of the PacketMirroring resource to return. + */ + packetMirroring?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the region for this request. + * Name of the region for this request. */ region?: string; + } + export interface Params$Resource$Packetmirrorings$Insert + extends StandardParameters { /** - * Name or id of the resource for this request. + * Auth client or API Key for the request */ - resource?: string; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Request body metadata + * Project ID for this request. */ - requestBody?: Schema$TestPermissionsRequest; - } - - export class Resource$Nodetypes { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - + project?: string; /** - * compute.nodeTypes.aggregatedList - * @desc Retrieves an aggregated list of node types. - * @alias compute.nodeTypes.aggregatedList - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). - * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) - * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. - * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. - * @param {string} params.project Project ID for this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object + * Name of the region for this request. */ - aggregatedList( - params?: Params$Resource$Nodetypes$Aggregatedlist, - options?: MethodOptions - ): GaxiosPromise; - aggregatedList( - params: Params$Resource$Nodetypes$Aggregatedlist, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - aggregatedList( - params: Params$Resource$Nodetypes$Aggregatedlist, - callback: BodyResponseCallback - ): void; - aggregatedList( - callback: BodyResponseCallback - ): void; - aggregatedList( - paramsOrCallback?: - | Params$Resource$Nodetypes$Aggregatedlist - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Nodetypes$Aggregatedlist; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Nodetypes$Aggregatedlist; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/compute/v1/projects/{project}/aggregated/nodeTypes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['project'], - pathParams: ['project'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - + region?: string; /** - * compute.nodeTypes.get - * @desc Returns the specified node type. Gets a list of available node types by making a list() request. - * @alias compute.nodeTypes.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.nodeType Name of the node type to return. - * @param {string} params.project Project ID for this request. - * @param {string} params.zone The name of the zone for this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object + * 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). */ - get( - params?: Params$Resource$Nodetypes$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Nodetypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Nodetypes$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Nodetypes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Nodetypes$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/compute/v1/projects/{project}/zones/{zone}/nodeTypes/{nodeType}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['project', 'zone', 'nodeType'], - pathParams: ['nodeType', 'project', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } + requestId?: string; /** - * compute.nodeTypes.list - * @desc Retrieves a list of node types available to the specified project. - * @alias compute.nodeTypes.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true). - * @param {integer=} params.maxResults The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500) - * @param {string=} params.orderBy Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported. - * @param {string=} params.pageToken Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. - * @param {string} params.project Project ID for this request. - * @param {string} params.zone The name of the zone for this request. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object + * Request body metadata */ - list( - params?: Params$Resource$Nodetypes$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Nodetypes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Nodetypes$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Nodetypes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Nodetypes$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Nodetypes$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/compute/v1/projects/{project}/zones/{zone}/nodeTypes' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['project', 'zone'], - pathParams: ['project', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } + requestBody?: Schema$PacketMirroring; } - - export interface Params$Resource$Nodetypes$Aggregatedlist + export interface Params$Resource$Packetmirrorings$List extends StandardParameters { /** * Auth client or API Key for the request @@ -45628,56 +46975,64 @@ export namespace compute_v1 { * Project ID for this request. */ project?: string; + /** + * Name of the region for this request. + */ + region?: string; } - export interface Params$Resource$Nodetypes$Get extends StandardParameters { + export interface Params$Resource$Packetmirrorings$Patch + extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the node type to return. + * Name of the PacketMirroring resource to patch. */ - nodeType?: string; + packetMirroring?: string; /** * Project ID for this request. */ project?: string; /** - * The name of the zone for this request. + * Name of the region for this request. */ - zone?: string; - } - export interface Params$Resource$Nodetypes$List extends StandardParameters { + region?: string; /** - * Auth client or API Key for the request + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + requestId?: string; /** - * 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). + * Request body metadata */ - filter?: string; + requestBody?: Schema$PacketMirroring; + } + export interface Params$Resource$Packetmirrorings$Testiampermissions + extends StandardParameters { /** - * 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) + * Auth client or API Key for the request */ - maxResults?: number; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** - * 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. + * Project ID for this request. */ - orderBy?: string; + project?: 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. + * The name of the region for this request. */ - pageToken?: string; + region?: string; /** - * Project ID for this request. + * Name or id of the resource for this request. */ - project?: string; + resource?: string; + /** - * The name of the zone for this request. + * Request body metadata */ - zone?: string; + requestBody?: Schema$TestPermissionsRequest; } export class Resource$Projects { @@ -52442,6 +53797,85 @@ export namespace compute_v1 { } } + /** + * compute.regionInstanceGroupManagers.applyUpdatesToInstances + * @desc Apply updates to selected instances the managed instance group. + * @alias compute.regionInstanceGroupManagers.applyUpdatesToInstances + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instanceGroupManager The name of the managed instance group, should conform to RFC1035. + * @param {string} params.project Project ID for this request. + * @param {string} params.region Name of the region scoping this request, should conform to RFC1035. + * @param {().RegionInstanceGroupManagersApplyUpdatesRequest} params.requestBody Request 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 + */ + applyUpdatesToInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + options?: MethodOptions + ): GaxiosPromise; + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + params: Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances, + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + callback: BodyResponseCallback + ): void; + applyUpdatesToInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * compute.regionInstanceGroupManagers.createInstances * @desc Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method. @@ -54032,6 +55466,31 @@ export namespace compute_v1 { */ requestBody?: Schema$RegionInstanceGroupManagersAbandonInstancesRequest; } + export interface Params$Resource$Regioninstancegroupmanagers$Applyupdatestoinstances + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the managed instance group, should conform to RFC1035. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request, should conform to RFC1035. + */ + region?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersApplyUpdatesRequest; + } export interface Params$Resource$Regioninstancegroupmanagers$Createinstances extends StandardParameters { /** @@ -55494,7 +56953,7 @@ export namespace compute_v1 { /** * compute.regionOperations.wait - * @desc Waits for the specified region-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.regionOperations.wait * @memberOf! () * @@ -78277,7 +79736,7 @@ export namespace compute_v1 { /** * compute.zoneOperations.wait - * @desc Waits for the specified zone-specific Operations resource until it is done or timeout, and retrieves the specified Operations resource. 1. Immediately returns when the operation is already done. 2. Waits for no more than the default deadline (2 minutes, subject to change) and then returns the current state of the operation, which may be DONE or still in progress. 3. Is best-effort: a. The server can wait less than the default deadline or zero seconds, in overload situations. b. There is no guarantee that the operation is actually done when returns. 4. User should be prepared to retry if the operation is not DONE. + * @desc Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE. * @alias compute.zoneOperations.wait * @memberOf! () * diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 2938c9c5ad..3200db288d 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -170,6 +170,10 @@ export namespace container_v1 { * AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. */ export interface Schema$AutoprovisioningNodePoolDefaults { + /** + * Specifies the node management options for NAP created node-pools. + */ + management?: Schema$NodeManagement; /** * Scopes that are used by NAP when creating node pools. If oauth_scopes are specified, service_account should be empty. */ @@ -178,6 +182,10 @@ export namespace container_v1 { * The Google Cloud Platform Service Account to be used by the node VMs. If service_account is specified, scopes should be empty. */ serviceAccount?: string | null; + /** + * Specifies the upgrade settings for NAP created node pools + */ + upgradeSettings?: Schema$UpgradeSettings; } /** * AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. @@ -434,6 +442,10 @@ export namespace container_v1 { * [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. */ servicesIpv4Cidr?: string | null; + /** + * Shielded Nodes configuration. + */ + shieldedNodes?: Schema$ShieldedNodes; /** * [Output only] The current status of this cluster. */ @@ -544,6 +556,10 @@ export namespace container_v1 { * The desired configuration for exporting resource usage. */ desiredResourceUsageExportConfig?: Schema$ResourceUsageExportConfig; + /** + * Configuration for Shielded Nodes. + */ + desiredShieldedNodes?: Schema$ShieldedNodes; /** * Cluster-level Vertical Pod Autoscaling configuration. */ @@ -710,7 +726,7 @@ export namespace container_v1 { */ export interface Schema$HorizontalPodAutoscaling { /** - * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service. + * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring. */ disabled?: boolean | null; } @@ -1082,7 +1098,11 @@ export namespace container_v1 { */ reservationAffinity?: Schema$ReservationAffinity; /** - * The Google Cloud Platform Service Account to be used by the node VMs. If no Service Account is specified, the "default" service account is used. + * Sandbox configuration for this node. + */ + sandboxConfig?: Schema$SandboxConfig; + /** + * The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. */ serviceAccount?: string | null; /** @@ -1139,6 +1159,10 @@ export namespace container_v1 { * [Output only] The resource URLs of the [managed instance groups](/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. */ instanceGroupUrls?: string[] | null; + /** + * The list of Google Compute Engine [zones](/compute/docs/zones#available) in which the NodePool's nodes should be located. + */ + locations?: string[] | null; /** * NodeManagement configuration for this NodePool. */ @@ -1167,6 +1191,10 @@ export namespace container_v1 { * [Output only] Additional information about the current status of this node pool instance, if available. */ statusMessage?: string | null; + /** + * Upgrade settings control disruption and speed of the upgrade. + */ + upgradeSettings?: Schema$UpgradeSettings; /** * The version of the Kubernetes of this node. */ @@ -1283,6 +1311,10 @@ export namespace container_v1 { * The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network. */ masterIpv4CidrBlock?: string | null; + /** + * Output only. The peering name in the customer VPC used by this cluster. + */ + peeringName?: string | null; /** * Output only. The internal IP address of this cluster's master endpoint. */ @@ -1381,6 +1413,15 @@ export namespace container_v1 { */ zone?: string | null; } + /** + * SandboxConfig contains configurations of the sandbox to use for the node. + */ + export interface Schema$SandboxConfig { + /** + * Type of the sandbox to use for the node. + */ + type?: string | null; + } /** * Kubernetes Engine service configuration. */ @@ -1739,6 +1780,15 @@ export namespace container_v1 { */ enableSecureBoot?: boolean | null; } + /** + * Configuration of Shielded Nodes feature. + */ + export interface Schema$ShieldedNodes { + /** + * Whether Shielded Nodes features are enabled on all nodes in this cluster. + */ + enabled?: boolean | null; + } /** * StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP. */ @@ -1852,6 +1902,10 @@ export namespace container_v1 { * Required. The desired image type for the node pool. */ imageType?: string | null; + /** + * The desired list of Google Compute Engine [zones](/compute/docs/zones#available) in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. + */ + locations?: string[] | null; /** * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format 'projects/x/locations/x/clusters/x/nodePools/*'. */ @@ -1868,11 +1922,28 @@ export namespace container_v1 { * Required. Deprecated. The Google Developers Console [project ID or project number](https://support.google.com/cloud/answer/6158840). This field has been deprecated and replaced by the name field. */ projectId?: string | null; + /** + * Upgrade settings control disruption and speed of the upgrade. + */ + upgradeSettings?: Schema$UpgradeSettings; /** * Required. Deprecated. The name of the Google Compute Engine [zone](/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. */ zone?: string | null; } + /** + * These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. + */ + export interface Schema$UpgradeSettings { + /** + * The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process. + */ + maxSurge?: number | null; + /** + * The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready. + */ + maxUnavailable?: number | null; + } /** * UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range. */ @@ -3291,7 +3362,7 @@ export namespace container_v1 { /** * container.projects.locations.clusters.setLocations - * @desc Sets the locations for a specific cluster. + * @desc Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.update) instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -7889,7 +7960,7 @@ export namespace container_v1 { /** * container.projects.zones.clusters.locations - * @desc Sets the locations for a specific cluster. + * @desc Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.update) instead. * @example * * // BEFORE RUNNING: * // --------------- diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 564dd960a8..e7cedc7a7f 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -140,6 +140,10 @@ export namespace container_v1beta1 { * Configuration for NodeLocalDNS, a dns cache running on cluster nodes */ dnsCacheConfig?: Schema$DnsCacheConfig; + /** + * Configuration for the GCE PD CSI driver. This option can only be enabled at cluster creation time. + */ + gcePersistentDiskCsiDriverConfig?: Schema$GcePersistentDiskCsiDriverConfig; /** * Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. */ @@ -186,6 +190,10 @@ export namespace container_v1beta1 { * Specifies the node management options for NAP created node-pools. */ management?: Schema$NodeManagement; + /** + * Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value. + */ + minCpuPlatform?: string | null; /** * Scopes that are used by NAP when creating node pools. If oauth_scopes are specified, service_account should be empty. */ @@ -779,6 +787,15 @@ export namespace container_v1beta1 { */ tier?: string | null; } + /** + * Configuration for the GCE PD CSI driver. This option can only be enabled at cluster creation time. + */ + export interface Schema$GcePersistentDiskCsiDriverConfig { + /** + * Whether the GCE PD CSI driver is enabled for this cluster. + */ + enabled?: boolean | null; + } /** * GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517 */ @@ -834,7 +851,7 @@ export namespace container_v1beta1 { */ export interface Schema$HorizontalPodAutoscaling { /** - * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that a Heapster pod is running in the cluster, which is also used by the Cloud Monitoring service. + * Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring. */ disabled?: boolean | null; } @@ -1235,6 +1252,10 @@ export namespace container_v1beta1 { * A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. */ accelerators?: Schema$AcceleratorConfig[]; + /** + * The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption + */ + bootDiskKmsKey?: string | null; /** * Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. */ @@ -1264,7 +1285,7 @@ export namespace container_v1beta1 { */ metadata?: {[key: string]: string} | null; /** - * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) To unset the min cpu platform field pass "automatic" as field value. + * Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as <code>minCpuPlatform: &quot;Intel Haswell&quot;</code> or <code>minCpuPlatform: &quot;Intel Sandy Bridge&quot;</code>. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform) */ minCpuPlatform?: string | null; /** @@ -1284,7 +1305,7 @@ export namespace container_v1beta1 { */ 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 is used. + * The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. */ serviceAccount?: string | null; /** @@ -1684,6 +1705,10 @@ export namespace container_v1beta1 { * Type of the sandbox to use for the node (e.g. 'gvisor') */ sandboxType?: string | null; + /** + * Type of the sandbox to use for the node. + */ + type?: string | null; } /** * Kubernetes Engine service configuration. @@ -3268,7 +3293,7 @@ export namespace container_v1beta1 { /** * container.projects.locations.clusters.setLocations - * @desc Sets the locations for a specific cluster. + * @desc Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.update) instead. * @alias container.projects.locations.clusters.setLocations * @memberOf! () * @@ -6245,7 +6270,7 @@ export namespace container_v1beta1 { /** * container.projects.zones.clusters.locations - * @desc Sets the locations for a specific cluster. + * @desc Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.update) instead. * @alias container.projects.zones.clusters.locations * @memberOf! () * diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 0ecff0cd19..9e701feddd 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -507,23 +507,23 @@ export namespace containeranalysis_v1alpha1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index dd4bea3406..109c19b760 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -570,23 +570,23 @@ export namespace containeranalysis_v1beta1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 49fbb4c3ae..e384151079 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -332,6 +332,10 @@ export namespace content_v2_1 { * Type of the link between the two accounts. */ linkType?: string | null; + /** + * List of provided services. + */ + services?: string[] | null; } export interface Schema$AccountsCustomBatchResponse { /** @@ -377,6 +381,10 @@ export namespace content_v2_1 { * Type of the link between the two accounts. */ linkType?: string | null; + /** + * List of provided services. + */ + services?: string[] | null; } export interface Schema$AccountsLinkResponse { /** @@ -384,6 +392,20 @@ export namespace content_v2_1 { */ kind?: string | null; } + export interface Schema$AccountsListLinksResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "content#accountsListLinksResponse". + */ + kind?: string | null; + /** + * The list of available links. + */ + links?: Schema$LinkedAccount[]; + /** + * The token for the retrieval of the next page of links. + */ + nextPageToken?: string | null; + } export interface Schema$AccountsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#accountsListResponse". @@ -1606,6 +1628,26 @@ export namespace content_v2_1 { */ kind?: string | null; } + export interface Schema$LinkedAccount { + /** + * The ID of the linked account. + */ + linkedAccountId?: string | null; + /** + * List of provided services. + */ + services?: Schema$LinkService[]; + } + export interface Schema$LinkService { + /** + * Service provided to or by the linked account. + */ + service?: string | null; + /** + * Status of the link + */ + status?: string | null; + } export interface Schema$LocationIdSet { /** * A non-empty list of location IDs. They must all be of the same location type (e.g., state). @@ -2568,7 +2610,7 @@ export namespace content_v2_1 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) + * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) - "db schenker" (DB Schenker) */ carrier?: string | null; /** @@ -2890,6 +2932,30 @@ export namespace content_v2_1 { */ kind?: string | null; } + export interface Schema$PickupCarrierService { + /** + * The name of the pickup carrier (e.g., "UPS"). Required. + */ + carrierName?: string | null; + /** + * The name of the pickup service (e.g., "Access point"). Required. + */ + serviceName?: string | null; + } + export interface Schema$PickupServicesPickupService { + /** + * The name of the carrier (e.g., "UPS"). Always present. + */ + carrierName?: string | null; + /** + * The CLDR country code of the carrier (e.g., "US"). Always present. + */ + country?: string | null; + /** + * The name of the pickup service (e.g., "Access point"). Always present. + */ + serviceName?: string | null; + } export interface Schema$PosCustomBatchRequest { /** * The request entries to be processed in the batch. @@ -4339,10 +4405,18 @@ export namespace content_v2_1 { * Free-form name of the service. Must be unique within target account. Required. */ name?: string | null; + /** + * The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the getSupportedPickupServices method. Required if and only if the service delivery type is pickup. + */ + pickupService?: Schema$PickupCarrierService; /** * Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap. */ rateGroups?: Schema$RateGroup[]; + /** + * Type of locations this service ships orders to. + */ + shipmentType?: string | null; } export interface Schema$ShipmentInvoice { /** @@ -4476,6 +4550,16 @@ export namespace content_v2_1 { */ kind?: string | null; } + export interface Schema$ShippingsettingsGetSupportedPickupServicesResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedPickupServicesResponse". + */ + kind?: string | null; + /** + * A list of supported pickup services. May be empty. + */ + pickupServices?: Schema$PickupServicesPickupService[]; + } export interface Schema$ShippingsettingsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse". @@ -5338,6 +5422,90 @@ export namespace content_v2_1 { } } + /** + * content.accounts.listlinks + * @desc Returns the list of accounts linked to your Merchant Center account. + * @alias content.accounts.listlinks + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.accountId The ID of the account for which to list links. + * @param {integer=} params.maxResults The maximum number of links to return in the response, used for pagination. + * @param {string} params.merchantId The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. + * @param {string=} params.pageToken The token returned by the previous 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 + */ + listlinks( + params?: Params$Resource$Accounts$Listlinks, + options?: MethodOptions + ): GaxiosPromise; + listlinks( + params: Params$Resource$Accounts$Listlinks, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listlinks( + params: Params$Resource$Accounts$Listlinks, + callback: BodyResponseCallback + ): void; + listlinks( + callback: BodyResponseCallback + ): void; + listlinks( + paramsOrCallback?: + | Params$Resource$Accounts$Listlinks + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Accounts$Listlinks; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Accounts$Listlinks; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/content/v2.1/{merchantId}/accounts/{accountId}/listlinks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['merchantId', 'accountId'], + pathParams: ['accountId', 'merchantId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * content.accounts.update * @desc Updates a Merchant Center account. @@ -5539,6 +5707,30 @@ export namespace content_v2_1 { */ pageToken?: string; } + export interface Params$Resource$Accounts$Listlinks + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the account for which to list links. + */ + accountId?: string; + /** + * The maximum number of links to return in the response, used for pagination. + */ + maxResults?: number; + /** + * The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account. + */ + merchantId?: string; + /** + * The token returned by the previous request. + */ + pageToken?: string; + } export interface Params$Resource$Accounts$Update extends StandardParameters { /** * Auth client or API Key for the request @@ -13952,6 +14144,103 @@ export namespace content_v2_1 { } } + /** + * content.shippingsettings.getsupportedpickupservices + * @desc Retrieves supported pickup services for an account. + * @alias content.shippingsettings.getsupportedpickupservices + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.merchantId The ID of the account for which to retrieve the supported pickup services. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getsupportedpickupservices( + params?: Params$Resource$Shippingsettings$Getsupportedpickupservices, + options?: MethodOptions + ): GaxiosPromise; + getsupportedpickupservices( + params: Params$Resource$Shippingsettings$Getsupportedpickupservices, + options: + | MethodOptions + | BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >, + callback: BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > + ): void; + getsupportedpickupservices( + params: Params$Resource$Shippingsettings$Getsupportedpickupservices, + callback: BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > + ): void; + getsupportedpickupservices( + callback: BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > + ): void; + getsupportedpickupservices( + paramsOrCallback?: + | Params$Resource$Shippingsettings$Getsupportedpickupservices + | BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >, + callback?: BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > + ): void | GaxiosPromise< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Shippingsettings$Getsupportedpickupservices; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Shippingsettings$Getsupportedpickupservices; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/content/v2.1/{merchantId}/supportedPickupServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['merchantId'], + pathParams: ['merchantId'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >(parameters); + } + } + /** * content.shippingsettings.list * @desc Lists the shipping settings of the sub-accounts in your Merchant Center account. @@ -14165,6 +14454,18 @@ export namespace content_v2_1 { */ merchantId?: string; } + export interface Params$Resource$Shippingsettings$Getsupportedpickupservices + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the account for which to retrieve the supported pickup services. + */ + merchantId?: string; + } export interface Params$Resource$Shippingsettings$List extends StandardParameters { /** diff --git a/src/apis/content/v2.ts b/src/apis/content/v2.ts index 8acade05d0..a9da16d752 100644 --- a/src/apis/content/v2.ts +++ b/src/apis/content/v2.ts @@ -3198,7 +3198,7 @@ export namespace content_v2 { } export interface Schema$OrderShipment { /** - * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) + * The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. Note: You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - "ups" (United Parcel Service) automatic status updates - "usps" (United States Postal Service) automatic status updates - "fedex" (FedEx) automatic status updates - "dhl" (DHL eCommerce) automatic status updates (US only) - "ontrac" (OnTrac) automatic status updates - "dhl express" (DHL Express) - "deliv" (Deliv) - "dynamex" (TForce) - "lasership" (LaserShip) - "mpx" (Military Parcel Xpress) - "uds" (United Delivery Service) - "efw" (Estes Forwarding Worldwide) - "jd logistics" (JD Logistics) - "yunexpress" (YunExpress) - "china post" (China Post) - "china ems" (China Post Express Mail Service) - "singapore post" (Singapore Post) - "pos malaysia" (Pos Malaysia) - "postnl" (PostNL) - "ptt" (PTT Turkish Post) - "eub" (ePacket) - "chukou1" (Chukou1 Logistics) Supported carriers for FR are: - "la poste" (La Poste) automatic status updates - "colissimo" (Colissimo by La Poste) automatic status updates - "ups" (United Parcel Service) automatic status updates - "chronopost" (Chronopost by La Poste) - "gls" (General Logistics Systems France) - "dpd" (DPD Group by GeoPost) - "bpost" (Belgian Post Group) - "colis prive" (Colis Privé) - "boxtal" (Boxtal) - "geodis" (GEODIS) - "tnt" (TNT) - "db schenker" (DB Schenker) */ carrier?: string | null; /** @@ -3600,6 +3600,30 @@ export namespace content_v2 { */ kind?: string | null; } + export interface Schema$PickupCarrierService { + /** + * The name of the pickup carrier (e.g., "UPS"). Required. + */ + carrierName?: string | null; + /** + * The name of the pickup service (e.g., "Access point"). Required. + */ + serviceName?: string | null; + } + export interface Schema$PickupServicesPickupService { + /** + * The name of the carrier (e.g., "UPS"). Always present. + */ + carrierName?: string | null; + /** + * The CLDR country code of the carrier (e.g., "US"). Always present. + */ + country?: string | null; + /** + * The name of the pickup service (e.g., "Access point"). Always present. + */ + serviceName?: string | null; + } export interface Schema$PosCustomBatchRequest { /** * The request entries to be processed in the batch. @@ -4781,10 +4805,18 @@ export namespace content_v2 { * Free-form name of the service. Must be unique within target account. Required. */ name?: string | null; + /** + * The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the getSupportedPickupServices method. Required if and only if the service delivery type is pickup. + */ + pickupService?: Schema$PickupCarrierService; /** * Shipping rate group definitions. Only the last one is allowed to have an empty applicableShippingLabels, which means "everything else". The other applicableShippingLabels must not overlap. */ rateGroups?: Schema$RateGroup[]; + /** + * Type of locations this service ships orders to. + */ + shipmentType?: string | null; } export interface Schema$ShipmentInvoice { /** @@ -4918,6 +4950,16 @@ export namespace content_v2 { */ kind?: string | null; } + export interface Schema$ShippingsettingsGetSupportedPickupServicesResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsGetSupportedPickupServicesResponse". + */ + kind?: string | null; + /** + * A list of supported pickup services. May be empty. + */ + pickupServices?: Schema$PickupServicesPickupService[]; + } export interface Schema$ShippingsettingsListResponse { /** * Identifies what kind of resource this is. Value: the fixed string "content#shippingsettingsListResponse". @@ -13948,6 +13990,103 @@ export namespace content_v2 { } } + /** + * content.shippingsettings.getsupportedpickupservices + * @desc Retrieves supported pickup services for an account. + * @alias content.shippingsettings.getsupportedpickupservices + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.merchantId The ID of the account for which to retrieve the supported pickup services. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getsupportedpickupservices( + params?: Params$Resource$Shippingsettings$Getsupportedpickupservices, + options?: MethodOptions + ): GaxiosPromise; + getsupportedpickupservices( + params: Params$Resource$Shippingsettings$Getsupportedpickupservices, + options: + | MethodOptions + | BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >, + callback: BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > + ): void; + getsupportedpickupservices( + params: Params$Resource$Shippingsettings$Getsupportedpickupservices, + callback: BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > + ): void; + getsupportedpickupservices( + callback: BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > + ): void; + getsupportedpickupservices( + paramsOrCallback?: + | Params$Resource$Shippingsettings$Getsupportedpickupservices + | BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >, + callback?: BodyResponseCallback< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > + ): void | GaxiosPromise< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Shippingsettings$Getsupportedpickupservices; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Shippingsettings$Getsupportedpickupservices; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/content/v2/{merchantId}/supportedPickupServices' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['merchantId'], + pathParams: ['merchantId'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >(parameters, callback); + } else { + return createAPIRequest< + Schema$ShippingsettingsGetSupportedPickupServicesResponse + >(parameters); + } + } + /** * content.shippingsettings.list * @desc Lists the shipping settings of the sub-accounts in your Merchant Center account. @@ -14166,6 +14305,18 @@ export namespace content_v2 { */ merchantId?: string; } + export interface Params$Resource$Shippingsettings$Getsupportedpickupservices + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The ID of the account for which to retrieve the supported pickup services. + */ + merchantId?: string; + } export interface Params$Resource$Shippingsettings$List extends StandardParameters { /** diff --git a/src/apis/datacatalog/v1beta1.ts b/src/apis/datacatalog/v1beta1.ts index 62c81ae875..07e55b461d 100644 --- a/src/apis/datacatalog/v1beta1.ts +++ b/src/apis/datacatalog/v1beta1.ts @@ -141,23 +141,23 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -239,7 +239,7 @@ export namespace datacatalog_v1beta1 { type?: string | null; } /** - * Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform, such as a BigQuery dataset or a Cloud Pub/Sub topic. Clients can use the `linked_resource` field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag. + * Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Cloud Pub/Sub topic), or outside of Google Cloud Platform. Clients can use the `linked_resource` field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag. */ export interface Schema$GoogleCloudDatacatalogV1beta1Entry { /** @@ -263,7 +263,11 @@ export namespace datacatalog_v1beta1 { */ gcsFilesetSpec?: Schema$GoogleCloudDatacatalogV1beta1GcsFilesetSpec; /** - * Output only. The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [full name of the resource](https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId + * Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Cloud Pub/Sub. + */ + integratedSystem?: string | null; + /** + * The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [full name of the resource](https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string. */ linkedResource?: string | null; /** @@ -275,13 +279,21 @@ export namespace datacatalog_v1beta1 { */ schema?: Schema$GoogleCloudDatacatalogV1beta1Schema; /** - * Output only. Timestamps about the underlying Google Cloud Platform resource, not about this Data Catalog Entry. + * Output only. Timestamps about the underlying resource, not about this Data Catalog entry. Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp. */ sourceSystemTimestamps?: Schema$GoogleCloudDatacatalogV1beta1SystemTimestamps; /** - * The type of the entry. + * The type of the entry. Only used for Entries with types in the EntryType enum. */ type?: string | null; + /** + * This field indicates the entry's source system that Data Catalog does not integrate with. `user_specified_system` strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. + */ + userSpecifiedSystem?: string | null; + /** + * Entry type if it does not fit any of the input-allowed values listed in `EntryType` enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". `user_specified_type` strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use `user_specified_type`. + */ + userSpecifiedType?: string | null; } /** * EntryGroup Metadata. An EntryGroup resource represents a logical grouping of zero or more Data Catalog Entry resources. @@ -340,7 +352,7 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$GoogleCloudDatacatalogV1beta1GcsFilesetSpec { /** - * Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud Storage documentation](storage/docs/gsutil/addlhelp/WildcardNames) for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * `gs://bucket_name/dir/x: matches all files within `bucket_name/dir` directory. * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` spanning all subdirectories. * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/a/x/b`: matches all files in `bucket_name` that match `a/x/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` + * Required. Patterns to identify a set of files in Google Cloud Storage. See [Cloud Storage documentation](/storage/docs/gsutil/addlhelp/WildcardNames) for more information. Note that bucket wildcards are currently not supported. Examples of valid file_patterns: * `gs://bucket_name/dir/x: matches all files within `bucket_name/dir` directory. * `gs://bucket_name/dir/**`: matches all files in `bucket_name/dir` spanning all subdirectories. * `gs://bucket_name/file*`: matches files prefixed by `file` in `bucket_name` * `gs://bucket_name/??.txt`: matches files with two characters followed by `.txt` in `bucket_name` * `gs://bucket_name/[aeiou].txt`: matches files that contain a single vowel character followed by `.txt` in `bucket_name` * `gs://bucket_name/[a-m].txt`: matches files that contain `a`, `b`, ... or `m` followed by `.txt` in `bucket_name` * `gs://bucket_name/a/x/b`: matches all files in `bucket_name` that match `a/x/b` pattern, such as `a/c/b`, `a/d/b` * `gs://another_bucket/a.txt`: matches `gs://another_bucket/a.txt` You can combine wildcards to provide more powerful matches, for example: * `gs://bucket_name/[a-m]??.j*g` */ filePatterns?: string[] | null; /** @@ -392,6 +404,19 @@ export namespace datacatalog_v1beta1 { */ taxonomies?: Schema$GoogleCloudDatacatalogV1beta1SerializedTaxonomy[]; } + /** + * Response message for ListEntries. + */ + export interface Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse { + /** + * Entry details. + */ + entries?: Schema$GoogleCloudDatacatalogV1beta1Entry[]; + /** + * Token to retrieve the next page of results. It is set to empty if no items remain in results. + */ + nextPageToken?: string | null; + } /** * Response message for ListPolicyTags. */ @@ -432,7 +457,7 @@ export namespace datacatalog_v1beta1 { taxonomies?: Schema$GoogleCloudDatacatalogV1beta1Taxonomy[]; } /** - * Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierachy: Geolocation -&gt; (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode". + * Denotes one policy tag in a taxonomy (e.g. ssn). Policy Tags can be defined in a hierarchy. For example, consider the following hierarchy: Geolocation -&gt; (LatLong, City, ZipCode). PolicyTag "Geolocation" contains three child policy tags: "LatLong", "City", and "ZipCode". */ export interface Schema$GoogleCloudDatacatalogV1beta1PolicyTag { /** @@ -479,7 +504,7 @@ export namespace datacatalog_v1beta1 { */ export interface Schema$GoogleCloudDatacatalogV1beta1SearchCatalogRequest { /** - * Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports desecending * `last_access_timestamp [asc|desc]`, defaults to descending if not specified * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified If not specified, defaults to `relevance` descending. + * Specifies the ordering of results, currently supported case-sensitive choices are: * `relevance`, only supports descending * `last_modified_timestamp [asc|desc]`, defaults to descending if not specified If not specified, defaults to `relevance` descending. */ orderBy?: string | null; /** @@ -795,7 +820,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.catalog.search - * @desc Searches Data Catalog for multiple resources like entries, tags that match a query. This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequentally call `Get` methods. Note that searches do not have full recall. There may be results that match your query but are not returned, even in subsequent pages of results. These missing results may vary across repeated calls to search. Do not rely on this method if you need to guarantee full recall. See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information. + * @desc Searches Data Catalog for multiple resources like entries, tags that match a query. This is a custom method (https://cloud.google.com/apis/design/custom_methods) and does not return the complete resource, only the resource identifier and high level fields. Clients can subsequentally call `Get` methods. Note that Data Catalog search queries do not guarantee full recall. Query results that match your query may not be returned, even in subsequent result pages. Also note that results returned (and not returned) can vary across repeated search queries. See [Data Catalog Search Syntax](/data-catalog/docs/how-to/search-reference) for more information. * @alias datacatalog.catalog.search * @memberOf! () * @@ -917,7 +942,7 @@ export namespace datacatalog_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.linkedResource The full name of the Google Cloud Platform resource the Data Catalog entry represents. See: https://cloud.google.com/apis/design/resource_names#full_resource_name. Full names are case-sensitive. Examples: * //bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId * //pubsub.googleapis.com/projects/projectId/topics/topicId - * @param {string=} params.sqlResource The SQL name of the entry. SQL names are case-sensitive. Examples: * `cloud_pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. + * @param {string=} params.sqlResource The SQL name of the entry. SQL names are case-sensitive. Examples: * `cloud_pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1004,7 +1029,7 @@ export namespace datacatalog_v1beta1 { */ linkedResource?: string; /** - * The SQL name of the entry. SQL names are case-sensitive. Examples: * `cloud_pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. + * The SQL name of the entry. SQL names are case-sensitive. Examples: * `cloud_pubsub.project_id.topic_id` * ``pubsub.project_id.`topic.id.with.dots` `` * `bigquery.table.project_id.dataset_id.table_id` * `bigquery.dataset.project_id.dataset_id` * `datacatalog.entry.project_id.location_id.entry_group_id.entry_id` `*_id`s shoud satisfy the standard SQL rules for identifiers. https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical. */ sqlResource?: string; } @@ -1040,16 +1065,20 @@ export namespace datacatalog_v1beta1 { export class Resource$Projects$Locations$Entrygroups { context: APIRequestContext; entries: Resource$Projects$Locations$Entrygroups$Entries; + tags: Resource$Projects$Locations$Entrygroups$Tags; constructor(context: APIRequestContext) { this.context = context; this.entries = new Resource$Projects$Locations$Entrygroups$Entries( this.context ); + this.tags = new Resource$Projects$Locations$Entrygroups$Tags( + this.context + ); } /** * datacatalog.projects.locations.entryGroups.create - * @desc Alpha feature. Creates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc A maximum of 10,000 entry groups may be created per organization across all locations. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.entryGroups.create * @memberOf! () * @@ -1142,7 +1171,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.delete - * @desc Alpha feature. Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Deletes an EntryGroup. Only entry groups that do not contain entries can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.entryGroups.delete * @memberOf! () * @@ -1212,7 +1241,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.get - * @desc Alpha feature. Gets an EntryGroup. + * @desc Gets an EntryGroup. * @alias datacatalog.projects.locations.entryGroups.get * @memberOf! () * @@ -1372,6 +1401,96 @@ export namespace datacatalog_v1beta1 { } } + /** + * datacatalog.projects.locations.entryGroups.patch + * @desc Updates an EntryGroup. The user should enable the Data Catalog API in the project identified by the `entry_group.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @alias datacatalog.projects.locations.entryGroups.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the entry group in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name. + * @param {string=} params.updateMask The fields to update on the entry group. If absent or empty, all modifiable fields are updated. + * @param {().GoogleCloudDatacatalogV1beta1EntryGroup} params.requestBody Request 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$Entrygroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1EntryGroup + > + ): void; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Patch, + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1EntryGroup + > + ): void; + patch( + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1EntryGroup + > + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1EntryGroup + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datacatalog.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 + ); + } + } + /** * datacatalog.projects.locations.entryGroups.setIamPolicy * @desc Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. @@ -1598,6 +1717,27 @@ export namespace datacatalog_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } + export interface Params$Resource$Projects$Locations$Entrygroups$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the entry group in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} Note that this EntryGroup and its child resources may not actually be stored in the location in this name. + */ + name?: string; + /** + * The fields to update on the entry group. If absent or empty, all modifiable fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDatacatalogV1beta1EntryGroup; + } export interface Params$Resource$Projects$Locations$Entrygroups$Setiampolicy extends StandardParameters { /** @@ -1645,7 +1785,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.entries.create - * @desc Alpha feature. Creates an entry. Currently only entries of 'FILESET' type can be created. The user should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Creates an entry. Only entries of 'FILESET' type or user-specified type can be created. Users should enable the Data Catalog API in the project identified by the `parent` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). A maximum of 100,000 entries may be created per entry group. * @alias datacatalog.projects.locations.entryGroups.entries.create * @memberOf! () * @@ -1730,7 +1870,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.entryGroups.entries.delete - * @desc Alpha feature. Deletes an existing entry. Only entries created through CreateEntry method can be deleted. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Deletes an existing entry. Only entries created through CreateEntry method can be deleted. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.entryGroups.entries.delete * @memberOf! () * @@ -1804,7 +1944,7 @@ export namespace datacatalog_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The name of the entry. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Entry groups are logical groupings of entries. Currently, users cannot create/modify entry groups. They are created by Data Catalog; they include `@bigquery` for all BigQuery entries, and `@pubsub` for all Cloud Pub/Sub entries. + * @param {string} params.name Required. The name of the entry. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_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 @@ -1951,53 +2091,70 @@ export namespace datacatalog_v1beta1 { } /** - * datacatalog.projects.locations.entryGroups.entries.patch - * @desc Updates an existing entry. The user should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). - * @alias datacatalog.projects.locations.entryGroups.entries.patch + * datacatalog.projects.locations.entryGroups.entries.list + * @desc Lists entries. + * @alias datacatalog.projects.locations.entryGroups.entries.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name. - * @param {string=} params.updateMask The fields to update on the entry. If absent or empty, all modifiable fields are updated. The following fields are modifiable: * For entries with type `DATA_STREAM`: * `schema` * For entries with type `FILESET` * `schema` * `display_name` * `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns` - * @param {().GoogleCloudDatacatalogV1beta1Entry} params.requestBody Request body data + * @param {integer=} params.pageSize The maximum number of items to return. Default is 10. Max limit is 1000. Throws an invalid argument for `page_size > 1000`. + * @param {string=} params.pageToken Token that specifies which page is requested. If empty, the first page is returned. + * @param {string} params.parent Required. The name of the entry group that contains the entries, which can be provided in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} + * @param {string=} params.readMask The fields to return for each Entry. If not set or empty, all fields are returned. For example, setting read_mask to contain only one path "name" will cause ListEntries to return a list of Entries with only "name" 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$Entrygroups$Entries$Patch, + list( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + > ): void; - patch( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$List, + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + > ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + > ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Entries$Patch - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Entrygroups$Entries$List + | BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + >, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + > { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Entries$List; options = {}; } @@ -2010,69 +2167,78 @@ export namespace datacatalog_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: (rootUrl + '/v1beta1/{+parent}/entries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + >(parameters, callback); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest< + Schema$GoogleCloudDatacatalogV1beta1ListEntriesResponse + >(parameters); } } /** - * datacatalog.projects.locations.entryGroups.entries.setIamPolicy - * @desc Sets the access control policy for a resource. Replaces any existing policy. Supported resources are: - Tag templates. - Entries. - Entry groups. Note, this method cannot be used to manage policies for BigQuery, Cloud Pub/Sub and any external Google Cloud Platform resources synced to Cloud Data Catalog. Callers must have following Google IAM permission - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag templates. - `datacatalog.entries.setIamPolicy` to set policies on entries. - `datacatalog.entryGroups.setIamPolicy` to set policies on entry groups. - * @alias datacatalog.projects.locations.entryGroups.entries.setIamPolicy + * datacatalog.projects.locations.entryGroups.entries.patch + * @desc Updates an existing entry. Users should enable the Data Catalog API in the project identified by the `entry.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @alias datacatalog.projects.locations.entryGroups.entries.patch * @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.requestBody Request body data + * @param {string} params.name The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name. + * @param {string=} params.updateMask The fields to update on the entry. If absent or empty, all modifiable fields are updated. The following fields are modifiable: * For entries with type `DATA_STREAM`: * `schema` * For entries with type `FILESET` * `schema` * `display_name` * `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns` * For entries with `user_specified_type` * `schema` * `display_name` * `description` * user_specified_type * user_specified_system * linked_resource * source_system_timestamps + * @param {().GoogleCloudDatacatalogV1beta1Entry} params.requestBody Request 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$Entrygroups$Entries$Setiampolicy, + patch( + params?: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Entrygroups$Entries$Setiampolicy, - callback: BodyResponseCallback + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Entries$Patch, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + patch( + callback: BodyResponseCallback + ): void; + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Entrygroups$Entries$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Entrygroups$Entries$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Entries$Patch; options = {}; } @@ -2085,23 +2251,25 @@ export namespace datacatalog_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -2229,7 +2397,7 @@ export namespace datacatalog_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the entry. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Entry groups are logical groupings of entries. Currently, users cannot create/modify entry groups. They are created by Data Catalog; they include `@bigquery` for all BigQuery entries, and `@pubsub` for all Cloud Pub/Sub entries. + * Required. The name of the entry. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} */ name?: string; } @@ -2250,7 +2418,7 @@ export namespace datacatalog_v1beta1 { */ requestBody?: Schema$GetIamPolicyRequest; } - export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Patch + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$List extends StandardParameters { /** * Auth client or API Key for the request @@ -2258,20 +2426,23 @@ export namespace datacatalog_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name. + * The maximum number of items to return. Default is 10. Max limit is 1000. Throws an invalid argument for `page_size > 1000`. */ - name?: string; + pageSize?: number; /** - * The fields to update on the entry. If absent or empty, all modifiable fields are updated. The following fields are modifiable: * For entries with type `DATA_STREAM`: * `schema` * For entries with type `FILESET` * `schema` * `display_name` * `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns` + * Token that specifies which page is requested. If empty, the first page is returned. */ - updateMask?: string; - + pageToken?: string; /** - * Request body metadata + * Required. The name of the entry group that contains the entries, which can be provided in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} */ - requestBody?: Schema$GoogleCloudDatacatalogV1beta1Entry; + parent?: string; + /** + * The fields to return for each Entry. If not set or empty, all fields are returned. For example, setting read_mask to contain only one path "name" will cause ListEntries to return a list of Entries with only "name" field. + */ + readMask?: string; } - export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Setiampolicy + export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Patch extends StandardParameters { /** * Auth client or API Key for the request @@ -2279,14 +2450,18 @@ export namespace datacatalog_v1beta1 { 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. + * The Data Catalog resource name of the entry in URL format. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Entry and its child resources may not actually be stored in the location in this name. */ - resource?: string; + name?: string; + /** + * The fields to update on the entry. If absent or empty, all modifiable fields are updated. The following fields are modifiable: * For entries with type `DATA_STREAM`: * `schema` * For entries with type `FILESET` * `schema` * `display_name` * `description` * `gcs_fileset_spec` * `gcs_fileset_spec.file_patterns` * For entries with `user_specified_type` * `schema` * `display_name` * `description` * user_specified_type * user_specified_system * linked_resource * source_system_timestamps + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$SetIamPolicyRequest; + requestBody?: Schema$GoogleCloudDatacatalogV1beta1Entry; } export interface Params$Resource$Projects$Locations$Entrygroups$Entries$Testiampermissions extends StandardParameters { @@ -2474,7 +2649,7 @@ export namespace datacatalog_v1beta1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of tags to return. Default is 10. Max limit is 1000. * @param {string=} params.pageToken Token that specifies which page is requested. If empty, the first page is returned. - * @param {string} params.parent Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry. + * @param {string} params.parent Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_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 @@ -2694,7 +2869,7 @@ export namespace datacatalog_v1beta1 { */ pageToken?: string; /** - * Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry. + * Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} */ parent?: string; } @@ -2720,6 +2895,420 @@ export namespace datacatalog_v1beta1 { requestBody?: Schema$GoogleCloudDatacatalogV1beta1Tag; } + export class Resource$Projects$Locations$Entrygroups$Tags { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * datacatalog.projects.locations.entryGroups.tags.create + * @desc Creates a tag on an Entry. Note: The project identified by the `parent` parameter for the [tag](/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters) and the [tag template](/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters) used to create the tag must be from the same organization. + * @alias datacatalog.projects.locations.entryGroups.tags.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Tag and its child resources may not actually be stored in the location in this name. + * @param {().GoogleCloudDatacatalogV1beta1Tag} params.requestBody Request 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$Entrygroups$Tags$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Tags$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Entrygroups$Tags$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Tags$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Tags$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Tags$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datacatalog.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/tags').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * datacatalog.projects.locations.entryGroups.tags.delete + * @desc Deletes a tag. + * @alias datacatalog.projects.locations.entryGroups.tags.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the tag to delete. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_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$Entrygroups$Tags$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Tags$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Entrygroups$Tags$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Tags$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Tags$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Tags$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datacatalog.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * datacatalog.projects.locations.entryGroups.tags.list + * @desc Lists the tags on an Entry. + * @alias datacatalog.projects.locations.entryGroups.tags.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of tags to return. Default is 10. Max limit is 1000. + * @param {string=} params.pageToken Token that specifies which page is requested. If empty, the first page is returned. + * @param {string} params.parent Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_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$Entrygroups$Tags$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Entrygroups$Tags$List, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + >, + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + > + ): void; + list( + params: Params$Resource$Projects$Locations$Entrygroups$Tags$List, + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Tags$List + | BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + > + ): void | GaxiosPromise< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Tags$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Tags$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datacatalog.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/tags').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$GoogleCloudDatacatalogV1beta1ListTagsResponse + >(parameters); + } + } + + /** + * datacatalog.projects.locations.entryGroups.tags.patch + * @desc Updates an existing tag. + * @alias datacatalog.projects.locations.entryGroups.tags.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name. + * @param {string=} params.updateMask The fields to update on the Tag. If absent or empty, all modifiable fields are updated. Currently the only modifiable field is the field `fields`. + * @param {().GoogleCloudDatacatalogV1beta1Tag} params.requestBody Request 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$Entrygroups$Tags$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Tags$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Entrygroups$Tags$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Entrygroups$Tags$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Entrygroups$Tags$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Entrygroups$Tags$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://datacatalog.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$Locations$Entrygroups$Tags$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the resource to attach this tag to. Tags can be attached to Entries. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} Note that this Tag and its child resources may not actually be stored in the location in this name. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDatacatalogV1beta1Tag; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Tags$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the tag to delete. Example: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Tags$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of tags to return. Default is 10. Max limit is 1000. + */ + pageSize?: number; + /** + * Token that specifies which page is requested. If empty, the first page is returned. + */ + pageToken?: string; + /** + * Required. The name of the Data Catalog resource to list the tags of. The resource could be an Entry or an EntryGroup. Examples: * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id} * projects/{project_id}/locations/{location}/entryGroups/{entry_group_id}/entries/{entry_id} + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Entrygroups$Tags$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The resource name of the tag in URL format. Example: * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id} where `tag_id` is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name. + */ + name?: string; + /** + * The fields to update on the Tag. If absent or empty, all modifiable fields are updated. Currently the only modifiable field is the field `fields`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDatacatalogV1beta1Tag; + } + export class Resource$Projects$Locations$Tagtemplates { context: APIRequestContext; fields: Resource$Projects$Locations$Tagtemplates$Fields; @@ -2737,7 +3326,7 @@ export namespace datacatalog_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The name of the project and the location this template is in. Example: * projects/{project_id}/locations/{location} TagTemplate and its child resources may not actually be stored in the location in this name. + * @param {string} params.parent Required. The name of the project and the template location [region](/compute/docs/regions-zones/#available). NOTE: Currently, only the `us-central1 region` is supported. Example: * projects/{project_id}/locations/us-central1 * @param {string=} params.tagTemplateId Required. The id of the tag template to create. * @param {().GoogleCloudDatacatalogV1beta1TagTemplate} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2825,7 +3414,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.delete - * @desc Deletes a tag template and all tags using the template. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Deletes a tag template and all tags using the template. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.delete * @memberOf! () * @@ -3056,7 +3645,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.patch - * @desc Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. The user should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Updates a tag template. This method cannot be used to update the fields of a template. The tag template fields are represented as separate resources and should be updated using their own create/update/delete methods. Users should enable the Data Catalog API in the project identified by the `tag_template.name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.patch * @memberOf! () * @@ -3308,7 +3897,7 @@ export namespace datacatalog_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the project and the location this template is in. Example: * projects/{project_id}/locations/{location} TagTemplate and its child resources may not actually be stored in the location in this name. + * Required. The name of the project and the template location [region](/compute/docs/regions-zones/#available). NOTE: Currently, only the `us-central1 region` is supported. Example: * projects/{project_id}/locations/us-central1 */ parent?: string; /** @@ -3435,7 +4024,7 @@ export namespace datacatalog_v1beta1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The name of the project this template is in. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplateField may not actually be stored in the location in this name. + * @param {string} params.parent Required. The name of the project and the template location [region](/compute/docs/regions-zones/#available). NOTE: Currently, only the `us-central1 region` is supported. Example: * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} * @param {string=} params.tagTemplateFieldId Required. The ID of the tag template field to create. Field ids can contain letters (both uppercase and lowercase), numbers (0-9), underscores (_) and dashes (-). Field IDs must be at least 1 character long and at most 128 characters long. Field IDs must also be unique within their template. * @param {().GoogleCloudDatacatalogV1beta1TagTemplateField} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3531,7 +4120,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.fields.delete - * @desc Deletes a field in a tag template and all uses of that field. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Deletes a field in a tag template and all uses of that field. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.fields.delete * @memberOf! () * @@ -3601,7 +4190,7 @@ export namespace datacatalog_v1beta1 { /** * datacatalog.projects.locations.tagTemplates.fields.patch - * @desc Updates a field in a tag template. This method cannot be used to update the field type. The user should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). + * @desc Updates a field in a tag template. This method cannot be used to update the field type. Users should enable the Data Catalog API in the project identified by the `name` parameter (see [Data Catalog Resource Project] (/data-catalog/docs/concepts/resource-project) for more information). * @alias datacatalog.projects.locations.tagTemplates.fields.patch * @memberOf! () * @@ -3806,7 +4395,7 @@ export namespace datacatalog_v1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The name of the project this template is in. Example: * projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id} Note that this TagTemplateField may not actually be stored in the location in this name. + * Required. The name of the project and the template location [region](/compute/docs/regions-zones/#available). NOTE: Currently, only the `us-central1 region` is supported. Example: * projects/{project_id}/locations/us-central1/tagTemplates/{tag_template_id} */ parent?: string; /** diff --git a/src/apis/dataflow/v1b3.ts b/src/apis/dataflow/v1b3.ts index 1e5d2e6a60..ff30c13bed 100644 --- a/src/apis/dataflow/v1b3.ts +++ b/src/apis/dataflow/v1b3.ts @@ -326,6 +326,23 @@ export namespace dataflow_v1b3 { */ position?: Schema$Position; } + /** + * Container Spec. + */ + export interface Schema$ContainerSpec { + /** + * Name of the docker container image. E.g., gcr.io/project/some-image + */ + image?: string | null; + /** + * Metadata describing a template including description and validation rules. + */ + metadata?: Schema$TemplateMetadata; + /** + * Required. SDK info of the Flex Template. + */ + sdkInfo?: Schema$SDKInfo; + } /** * CounterMetadata includes all static non-name non-value counter attributes. */ @@ -1214,6 +1231,49 @@ export namespace dataflow_v1b3 { */ start?: string | null; } + /** + * Launch FlexTemplate Parameter. + */ + export interface Schema$LaunchFlexTemplateParameter { + /** + * Spec about the container image to launch. + */ + containerSpec?: Schema$ContainerSpec; + /** + * Gcs path to a file with json serialized ContainerSpec as content. + */ + containerSpecGcsPath?: string | null; + /** + * Required. The job name to use for the created job. + */ + jobName?: string | null; + /** + * The parameters for FlexTemplate. Ex. {"num_workers":"5"} + */ + parameters?: {[key: string]: string} | null; + } + /** + * A request to launch a Cloud Dataflow job from a FlexTemplate. + */ + export interface Schema$LaunchFlexTemplateRequest { + /** + * Required. Parameter to launch a job form Flex Template. + */ + launchParameter?: Schema$LaunchFlexTemplateParameter; + /** + * If true, the request is validated but not actually executed. Defaults to false. + */ + validateOnly?: boolean | null; + } + /** + * Response to the request to launch a job from Flex Template. + */ + export interface Schema$LaunchFlexTemplateResponse { + /** + * The job that was launched, if the request was not a dry run and the job was successfully launched. + */ + job?: Schema$Job; + } /** * Parameters to provide to the template being launched. */ @@ -1312,7 +1372,7 @@ export namespace dataflow_v1b3 { nextPageToken?: string | null; } /** - * Response to a request to list Cloud Dataflow jobs. This may be a partial response, depending on the page size in the ListJobsRequest. + * Response to a request to list Cloud Dataflow jobs in a project. This might be a partial response, depending on the page size in the ListJobsRequest. However, if the project does not have any jobs, an instance of ListJobsResponse is not returned and the requests's response body is empty {}. */ export interface Schema$ListJobsResponse { /** @@ -1852,6 +1912,19 @@ export namespace dataflow_v1b3 { */ sdkInfo?: Schema$SDKInfo; } + /** + * Defines a SDK harness container for executing Dataflow pipelines. + */ + export interface Schema$SdkHarnessContainerImage { + /** + * A docker container image that resides in Google Container Registry. + */ + containerImage?: string | null; + /** + * If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed. + */ + useSingleCorePerContainer?: boolean | null; + } /** * SDK Information. */ @@ -2833,6 +2906,10 @@ export namespace dataflow_v1b3 { * Extra arguments for this worker pool. */ poolArgs?: {[key: string]: any} | null; + /** + * Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries. + */ + sdkHarnessContainerImages?: Schema$SdkHarnessContainerImage[]; /** * Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". */ @@ -2846,7 +2923,7 @@ export namespace dataflow_v1b3 { */ teardownPolicy?: string | null; /** - * Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. + * Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead. */ workerHarnessContainerImage?: string | null; /** @@ -4383,11 +4460,15 @@ export namespace dataflow_v1b3 { export class Resource$Projects$Locations { context: APIRequestContext; + flexTemplates: Resource$Projects$Locations$Flextemplates; jobs: Resource$Projects$Locations$Jobs; sql: Resource$Projects$Locations$Sql; templates: Resource$Projects$Locations$Templates; constructor(context: APIRequestContext) { this.context = context; + this.flexTemplates = new Resource$Projects$Locations$Flextemplates( + this.context + ); this.jobs = new Resource$Projects$Locations$Jobs(this.context); this.sql = new Resource$Projects$Locations$Sql(this.context); this.templates = new Resource$Projects$Locations$Templates(this.context); @@ -4499,6 +4580,118 @@ export namespace dataflow_v1b3 { requestBody?: Schema$SendWorkerMessagesRequest; } + export class Resource$Projects$Locations$Flextemplates { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dataflow.projects.locations.flexTemplates.launch + * @desc Launch a job with a FlexTemplate. + * @alias dataflow.projects.locations.flexTemplates.launch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.location Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. E.g., us-central1, us-west1. + * @param {string} params.projectId Required. The ID of the Cloud Platform project that the job belongs to. + * @param {().LaunchFlexTemplateRequest} params.requestBody Request 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 + */ + launch( + params?: Params$Resource$Projects$Locations$Flextemplates$Launch, + options?: MethodOptions + ): GaxiosPromise; + launch( + params: Params$Resource$Projects$Locations$Flextemplates$Launch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + launch( + params: Params$Resource$Projects$Locations$Flextemplates$Launch, + callback: BodyResponseCallback + ): void; + launch( + callback: BodyResponseCallback + ): void; + launch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Flextemplates$Launch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Flextemplates$Launch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Flextemplates$Launch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dataflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['projectId', 'location'], + pathParams: ['location', 'projectId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Flextemplates$Launch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. E.g., us-central1, us-west1. + */ + location?: string; + /** + * Required. The ID of the Cloud Platform project that the job belongs to. + */ + projectId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LaunchFlexTemplateRequest; + } + export class Resource$Projects$Locations$Jobs { context: APIRequestContext; debug: Resource$Projects$Locations$Jobs$Debug; diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index fa89f02b75..3891a26e0a 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -123,7 +123,6 @@ export namespace datafusion_v1beta1 { * The configuration for logging of each type of permission. */ auditLogConfigs?: Schema$AuditLogConfig[]; - exemptedMembers?: string[] | null; /** * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. */ @@ -137,21 +136,11 @@ export namespace datafusion_v1beta1 { * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */ exemptedMembers?: string[] | null; - ignoreChildExemptions?: boolean | null; /** * The log type that this config enables. */ logType?: string | null; } - /** - * Authorization-related information used by Cloud Audit Logging. - */ - export interface Schema$AuthorizationLoggingOptions { - /** - * The type of the permission that was checked. - */ - permissionType?: string | null; - } /** * Associates `members` with a `role`. */ @@ -161,7 +150,7 @@ export namespace datafusion_v1beta1 { */ condition?: Schema$Expr; /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. */ members?: string[] | null; /** @@ -173,105 +162,28 @@ export namespace datafusion_v1beta1 { * The request message for Operations.CancelOperation. */ export interface Schema$CancelOperationRequest {} - /** - * Write a Cloud Audit log - */ - export interface Schema$CloudAuditOptions { - /** - * Information used by the Cloud Audit Logging pipeline. - */ - authorizationLoggingOptions?: Schema$AuthorizationLoggingOptions; - /** - * The log_name to populate in the Cloud Audit Record. - */ - logName?: string | null; - } - /** - * A condition to be met. - */ - export interface Schema$Condition { - /** - * Trusted attributes supplied by the IAM system. - */ - iam?: string | null; - /** - * An operator to apply the subject with. - */ - op?: string | null; - /** - * Trusted attributes discharged by the service. - */ - svc?: string | null; - /** - * Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. - */ - sys?: string | null; - /** - * The objects of the condition. - */ - values?: string[] | null; - } - /** - * Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} - */ - export interface Schema$CounterOptions { - /** - * Custom fields. - */ - customFields?: Schema$CustomField[]; - /** - * The field value to attribute. - */ - field?: string | null; - /** - * The metric to update. - */ - metric?: string | null; - } - /** - * Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields. - */ - export interface Schema$CustomField { - /** - * Name is the field name. - */ - name?: string | null; - /** - * Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext. - */ - value?: string | null; - } - /** - * Write a Data Access (Gin) log - */ - export interface Schema$DataAccessOptions { - /** - * Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now. - */ - logMode?: string | null; - } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -308,7 +220,11 @@ export namespace datafusion_v1beta1 { */ enableStackdriverMonitoring?: boolean | null; /** - * The resource labels for instance to use to annotate any related underlying resources such as GCE VMs. The character '=' is not allowed to be used within the labels. + * Output only. Cloud Storage bucket generated by Data Fusion in the customer project. + */ + gcsBucket?: string | null; + /** + * The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. */ labels?: {[key: string]: string} | null; /** @@ -352,7 +268,7 @@ export namespace datafusion_v1beta1 { */ updateTime?: string | null; /** - * Current version of the Data Fusion. Only specifiable in Update. + * Current version of Data Fusion. */ version?: string | null; /** @@ -428,23 +344,6 @@ export namespace datafusion_v1beta1 { */ name?: string | null; } - /** - * Specifies what kind of log the caller must write - */ - export interface Schema$LogConfig { - /** - * Cloud audit options. - */ - cloudAudit?: Schema$CloudAuditOptions; - /** - * Counter options. - */ - counter?: Schema$CounterOptions; - /** - * Data access options. - */ - dataAccess?: Schema$DataAccessOptions; - } /** * Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. */ @@ -517,7 +416,7 @@ export namespace datafusion_v1beta1 { verb?: string | null; } /** - * Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions (defined by IAM or configured by users). A `binding` can optionally specify a `condition`, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs). + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). */ export interface Schema$Policy { /** @@ -525,20 +424,15 @@ export namespace datafusion_v1beta1 { */ auditConfigs?: Schema$AuditConfig[]; /** - * Associates a list of `members` to a `role`. Optionally may specify a `condition` that determines when binding is in effect. `bindings` with no members will result in an error. + * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. */ 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. Due to blind-set semantics of an etag-less policy, 'setIamPolicy' will not fail even if either of incoming or stored policy does not meet the version requirements. + * `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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. */ etag?: string | null; - iamOwned?: boolean | null; /** - * If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. - */ - rules?: Schema$Rule[]; - /** - * Specifies the format of the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Operations affecting conditional bindings must specify version 3. This can be either setting a conditional policy, modifying a conditional binding, or removing a conditional binding from the stored conditional policy. Operations on non-conditional policies may specify any valid value or leave the field unset. If no etag is provided in the call to `setIamPolicy`, any version compliance checks on the incoming and/or stored policy is skipped. + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. */ version?: number | null; } @@ -546,39 +440,6 @@ export namespace datafusion_v1beta1 { * Request message for restarting a Data Fusion instance. */ export interface Schema$RestartInstanceRequest {} - /** - * A rule to be applied in a Policy. - */ - export interface Schema$Rule { - /** - * Required - */ - action?: string | null; - /** - * Additional restrictions that must be met. All conditions must pass for the rule to match. - */ - conditions?: Schema$Condition[]; - /** - * Human-readable description of the rule. - */ - description?: string | null; - /** - * If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. - */ - in?: string[] | null; - /** - * The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. - */ - logConfig?: Schema$LogConfig[]; - /** - * If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. The format for in and not_in entries can be found at in the Local IAM documentation (see go/local-iam#features). - */ - notIn?: string[] | null; - /** - * A permission is a string of form '<service>.<resource type>.<verb>' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. - */ - permissions?: string[] | null; - } /** * Request message for `SetIamPolicy` method. */ @@ -739,6 +600,7 @@ export namespace datafusion_v1beta1 { * * @param {object} params Parameters for request * @param {string=} params.filter The standard list filter. + * @param {boolean=} params.includeUnrevealedLocations If true, the returned list will include locations which are not yet revealed. * @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. @@ -834,6 +696,10 @@ export namespace datafusion_v1beta1 { * The standard list filter. */ filter?: string; + /** + * If true, the returned list will include locations which are not yet revealed. + */ + includeUnrevealedLocations?: boolean; /** * The resource that owns the locations collection, if applicable. */ diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index a6e51a48e8..ff38070f4c 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -470,23 +470,23 @@ export namespace dataproc_v1 { gcePdKmsKeyName?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -633,7 +633,7 @@ export namespace dataproc_v1 { weight?: number | null; } /** - * Optional. The config settings for Compute Engine resources in an instance group, such as a master or worker group. + * The config settings for Compute Engine resources in an instance group, such as a master or worker group. */ export interface Schema$InstanceGroupConfig { /** @@ -702,7 +702,13 @@ export namespace dataproc_v1 { * Output only. A URI pointing to the location of the stdout of the job's driver program. */ driverOutputResourceUri?: string | null; + /** + * Optional. Job is a Hadoop job. + */ hadoopJob?: Schema$HadoopJob; + /** + * Optional. Job is a Hive job. + */ hiveJob?: Schema$HiveJob; /** * Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time. @@ -712,11 +718,21 @@ export namespace dataproc_v1 { * Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. */ labels?: {[key: string]: string} | null; + /** + * Optional. Job is a Pig job. + */ pigJob?: Schema$PigJob; /** * Required. Job information, including how, when, and where to run the job. */ placement?: Schema$JobPlacement; + /** + * Optional. Job is a Presto job. + */ + prestoJob?: Schema$PrestoJob; + /** + * Optional. Job is a PySpark job. + */ pysparkJob?: Schema$PySparkJob; /** * Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>. @@ -726,8 +742,17 @@ export namespace dataproc_v1 { * Optional. Job scheduling configuration. */ scheduling?: Schema$JobScheduling; + /** + * Optional. Job is a Spark job. + */ sparkJob?: Schema$SparkJob; + /** + * Optional. Job is a SparkR job. + */ sparkRJob?: Schema$SparkRJob; + /** + * Optional. Job is a SparkSql job. + */ sparkSqlJob?: Schema$SparkSqlJob; /** * Output only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields. @@ -1116,6 +1141,39 @@ export namespace dataproc_v1 { */ version?: number | null; } + /** + * A Dataproc job for running Presto (https://prestosql.io/) queries + */ + export interface Schema$PrestoJob { + /** + * Optional. Presto client tags to attach to this query + */ + clientTags?: string[] | null; + /** + * Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries. + */ + continueOnFailure?: boolean | null; + /** + * Optional. The runtime log config for job execution. + */ + loggingConfig?: Schema$LoggingConfig; + /** + * Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats + */ + outputFormat?: string | null; + /** + * Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI + */ + properties?: {[key: string]: string} | null; + /** + * The HCFS URI of the script that contains SQL queries. + */ + queryFileUri?: string | null; + /** + * A list of queries. + */ + queryList?: Schema$QueryList; + } /** * A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. */ diff --git a/src/apis/dataproc/v1beta2.ts b/src/apis/dataproc/v1beta2.ts index 99770f0b6d..87cecd95d0 100644 --- a/src/apis/dataproc/v1beta2.ts +++ b/src/apis/dataproc/v1beta2.ts @@ -487,23 +487,23 @@ export namespace dataproc_v1beta2 { httpPorts?: {[key: string]: string} | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/dfareporting/v3.4.ts b/src/apis/dfareporting/v3.4.ts index 736623b352..86d41aa8a8 100644 --- a/src/apis/dfareporting/v3.4.ts +++ b/src/apis/dfareporting/v3.4.ts @@ -3061,10 +3061,6 @@ export namespace dfareporting_v3_4 { * DirectorySites contains properties of a website from the Site Directory. Sites need to be added to an account via the Sites resource before they can be assigned to a placement. */ export interface Schema$DirectorySite { - /** - * Whether this directory site is active. - */ - active?: boolean | null; /** * ID of this directory site. This is a read-only, auto-generated field. */ diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index e42aed8974..a84c6519c7 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -120,45 +120,70 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2Agent { /** - * Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow-enterprise/docs/integrations/web-demo) integration. + * Optional. API version displayed in Dialogflow console. If not specified, V2 API is assumed. Clients are free to query different service endpoints for different API versions. However, bots connectors and webhook calls will follow the specified API version. */ - avatarUri?: string; + apiVersion?: string | null; + /** + * Optional. The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. + */ + avatarUri?: string | null; /** * Optional. To filter out false positive results and still get variety in matched natural language inputs for your agent, you can tune the machine learning classification threshold. If the returned score value is less than the threshold value, then a fallback intent will be triggered or, if there are no fallback intents defined, no intent will be triggered. The score values range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0.0, the default of 0.3 is used. */ - classificationThreshold?: number; + classificationThreshold?: number | null; /** - * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method. + * Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the `Update` method. */ - defaultLanguageCode?: string; + defaultLanguageCode?: string | null; /** * Optional. The description of this agent. The maximum length is 500 characters. If exceeded, the request is rejected. */ - description?: string; + description?: string | null; /** * Required. The name of this agent. */ - displayName?: string; + displayName?: string | null; /** * Optional. Determines whether this agent should log conversation queries. */ - enableLogging?: boolean; + enableLogging?: boolean | null; /** * Optional. Determines how intents are detected from user queries. */ - matchMode?: string; + matchMode?: string | null; /** * Required. The project of this agent. Format: `projects/<Project ID>`. */ - parent?: string; + parent?: string | null; /** * Optional. The list of all languages supported by this agent (except for the `default_language_code`). */ - supportedLanguageCodes?: string[]; + supportedLanguageCodes?: string[] | null; + /** + * Optional. The agent tier. If not specified, TIER_STANDARD is assumed. + */ + tier?: string | null; /** * Required. The time zone of this agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. */ - timeZone?: string; + timeZone?: string | null; + } + /** + * Represents a part of a message possibly annotated with an entity. The part can be an entity or purely a part of the message between two entities or message start/end. + */ + export interface Schema$GoogleCloudDialogflowV2AnnotatedMessagePart { + /** + * The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. If this is empty, Dialogflow could not annotate the phrase part with a system entity. + */ + entityType?: string | null; + /** + * The [Dialogflow system entity formatted value ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of this message part. For example for a system entity of type `@sys.unit-currency`, this may contain: <pre> { "amount": 5, "currency": "USD" } </pre> + */ + formattedValue?: any | null; + /** + * A part of a message possibly annotated with an entity. + */ + text?: string | null; } /** * The request message for EntityTypes.BatchCreateEntities. @@ -169,22 +194,22 @@ export namespace dialogflow_v2 { */ entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[]; /** - * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ - languageCode?: string; + languageCode?: string | null; } /** * The request message for EntityTypes.BatchDeleteEntities. */ export interface Schema$GoogleCloudDialogflowV2BatchDeleteEntitiesRequest { /** - * Required. The canonical `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/<Project ID>`. + * Required. The reference `values` of the entities to delete. Note that these are not fully-qualified names, i.e. they don't start with `projects/<Project ID>`. */ - entityValues?: string[]; + entityValues?: string[] | null; /** - * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ - languageCode?: string; + languageCode?: string | null; } /** * The request message for EntityTypes.BatchDeleteEntityTypes. @@ -193,7 +218,7 @@ export namespace dialogflow_v2 { /** * Required. The names entity types to delete. All names must point to the same agent as `parent`. */ - entityTypeNames?: string[]; + entityTypeNames?: string[] | null; } /** * The request message for Intents.BatchDeleteIntents. @@ -213,13 +238,13 @@ export namespace dialogflow_v2 { */ entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[]; /** - * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of entity synonyms defined in `entities`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ - languageCode?: string; + languageCode?: string | null; /** * Optional. The mask to control which fields get updated. */ - updateMask?: string; + updateMask?: string | null; } /** * The request message for EntityTypes.BatchUpdateEntityTypes. @@ -232,15 +257,15 @@ export namespace dialogflow_v2 { /** * The URI to a Google Cloud Storage file containing entity types to update or create. The file format can either be a serialized proto (of EntityBatch type) or a JSON object. Note: The URI must start with "gs://". */ - entityTypeBatchUri?: string; + entityTypeBatchUri?: string | null; /** - * Optional. The language of entity synonyms defined in `entity_types`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of entity synonyms defined in `entity_types`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ - languageCode?: string; + languageCode?: string | null; /** * Optional. The mask to control which fields get updated. */ - updateMask?: string; + updateMask?: string | null; } /** * The response message for EntityTypes.BatchUpdateEntityTypes. @@ -262,19 +287,19 @@ export namespace dialogflow_v2 { /** * The URI to a Google Cloud Storage file containing intents to update or create. The file format can either be a serialized proto (of IntentBatch type) or JSON object. Note: The URI must start with "gs://". */ - intentBatchUri?: string; + intentBatchUri?: string | null; /** * Optional. The resource view to apply to the returned intent. */ - intentView?: string; + intentView?: string | null; /** - * Optional. The language of training phrases, parameters and rich messages defined in `intents`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intents`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ - languageCode?: string; + languageCode?: string | null; /** * Optional. The mask to control which fields get updated. */ - updateMask?: string; + updateMask?: string | null; } /** * The response message for Intents.BatchUpdateIntents. @@ -285,6 +310,39 @@ export namespace dialogflow_v2 { */ intents?: Schema$GoogleCloudDialogflowV2Intent[]; } + /** + * Represents an annotated conversation dataset. ConversationDataset can have multiple AnnotatedConversationDataset, each of them represents one result from one annotation task. AnnotatedConversationDataset can only be generated from annotation task, which will be triggered by LabelConversation. + */ + export interface Schema$GoogleCloudDialogflowV2beta1AnnotatedConversationDataset { + /** + * Output only. Number of examples that have annotations in the annotated conversation dataset. + */ + completedExampleCount?: string | null; + /** + * Output only. Creation time of this annotated conversation dataset. + */ + createTime?: string | null; + /** + * Optional. The description of the annotated conversation dataset. Maximum of 10000 bytes. + */ + description?: string | null; + /** + * Required. The display name of the annotated conversation dataset. It's specified when user starts an annotation task. Maximum of 64 bytes. + */ + displayName?: string | null; + /** + * Output only. Number of examples in the annotated conversation dataset. + */ + exampleCount?: string | null; + /** + * Output only. AnnotatedConversationDataset resource name. Format: `projects/<Project ID>/conversationDatasets/<Conversation Dataset ID>/annotatedConversationDatasets/<Annotated Conversation Dataset ID>` + */ + name?: string | null; + /** + * Output only. Question type name that identifies a labeling task. A question is a single task that a worker answers. A question type is set of related questions. Each question belongs to a particular question type. It can be used in CrowdCompute UI to filter and manage labeling tasks. + */ + questionTypeName?: string | null; + } /** * The response message for EntityTypes.BatchUpdateEntityTypes. */ @@ -310,15 +368,15 @@ export namespace dialogflow_v2 { /** * Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. */ - lifespanCount?: number; + lifespanCount?: number | null; /** - * Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. + * Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` */ - name?: string; + name?: string | null; /** - * Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) for syntax. + * Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters) for syntax. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; } /** * Represents an entity type. Entity types serve as a tool for extracting parameter values from natural language queries. @@ -327,11 +385,15 @@ export namespace dialogflow_v2 { /** * Optional. Indicates whether the entity type can be automatically expanded. */ - autoExpansionMode?: string; + autoExpansionMode?: string | null; /** * Required. The name of the entity type. */ - displayName?: string; + displayName?: string | null; + /** + * Optional. Enables fuzzy entity extraction during classification. + */ + enableFuzzyExtraction?: boolean | null; /** * Optional. The collection of entity entries associated with the entity type. */ @@ -339,11 +401,11 @@ export namespace dialogflow_v2 { /** * Required. Indicates the kind of entity type. */ - kind?: string; + kind?: string | null; /** * The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. */ - name?: string; + name?: string | null; } /** * An **entity entry** for an associated entity type. @@ -352,41 +414,41 @@ export namespace dialogflow_v2 { /** * Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. */ - synonyms?: string[]; + synonyms?: string[] | null; /** - * Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). + * Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). */ - value?: string; + value?: string | null; } /** * Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ export interface Schema$GoogleCloudDialogflowV2beta1EventInput { /** - * Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + * Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ - languageCode?: string; + languageCode?: string | null; /** * Required. The unique identifier of the event. */ - name?: string; + name?: string | null; /** - * Optional. The collection of parameters associated with the event. + * The collection of parameters associated with the event. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; } /** * The response message for Agents.ExportAgent. */ export interface Schema$GoogleCloudDialogflowV2beta1ExportAgentResponse { /** - * The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2beta1/projects/&lt;project_name&gt;/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".x/\1/' \ | base64 --decode > &lt;agent zip file&gt;</pre> + * Zip compressed raw byte content for agent. */ - agentContent?: string; + agentContent?: string | null; /** * The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`. */ - agentUri?: string; + agentUri?: string | null; } /** * Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. @@ -395,23 +457,23 @@ export namespace dialogflow_v2 { /** * Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. */ - action?: string; + action?: string | null; /** - * Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM. + * Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). */ - defaultResponsePlatforms?: string[]; + defaultResponsePlatforms?: string[] | null; /** * Required. The name of this intent. */ - displayName?: string; + displayName?: string | null; /** * Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. */ - endInteraction?: boolean; + endInteraction?: boolean | null; /** * Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. */ - events?: string[]; + events?: string[] | null; /** * Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. */ @@ -419,11 +481,11 @@ export namespace dialogflow_v2 { /** * Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ - inputContextNames?: string[]; + inputContextNames?: string[] | null; /** * Optional. Indicates whether this is a fallback intent. */ - isFallback?: boolean; + isFallback?: boolean | null; /** * Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. */ @@ -431,15 +493,15 @@ export namespace dialogflow_v2 { /** * Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. */ - mlDisabled?: boolean; + mlDisabled?: boolean | null; /** * Optional. Indicates whether Machine Learning is enabled for the intent. Note: If `ml_enabled` setting is set to false, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, then the default value is determined as follows: - Before April 15th, 2018 the default is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the default is: ml_enabled = true / ml_disabled = false. */ - mlEnabled?: boolean; + mlEnabled?: boolean | null; /** * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - name?: string; + name?: string | null; /** * Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ @@ -451,19 +513,19 @@ export namespace dialogflow_v2 { /** * Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - parentFollowupIntentName?: string; + parentFollowupIntentName?: string | null; /** - * Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled. + * The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. */ - priority?: number; + priority?: number | null; /** * Optional. Indicates whether to delete all contexts in the current session when this intent is matched. */ - resetContexts?: boolean; + resetContexts?: boolean | null; /** * Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - rootFollowupIntentName?: string; + rootFollowupIntentName?: string | null; /** * Optional. The collection of examples that the agent is trained on. */ @@ -471,7 +533,7 @@ export namespace dialogflow_v2 { /** * Optional. Indicates whether webhooks are enabled for the intent. */ - webhookState?: string; + webhookState?: string | null; } /** * Represents a single followup intent in the chain. @@ -480,11 +542,11 @@ export namespace dialogflow_v2 { /** * The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - followupIntentName?: string; + followupIntentName?: string | null; /** * The unique identifier of the followup intent's parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - parentFollowupIntentName?: string; + parentFollowupIntentName?: string | null; } /** * Corresponds to the `Response` field in the Dialogflow console. @@ -494,6 +556,10 @@ export namespace dialogflow_v2 { * Displays a basic card for Actions on Google. */ basicCard?: Schema$GoogleCloudDialogflowV2beta1IntentMessageBasicCard; + /** + * Browse carousel card for Actions on Google. + */ + browseCarouselCard?: Schema$GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard; /** * Displays a card. */ @@ -514,18 +580,34 @@ export namespace dialogflow_v2 { * Displays a list card for Actions on Google. */ listSelect?: Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelect; + /** + * The media content card for Actions on Google. + */ + mediaContent?: Schema$GoogleCloudDialogflowV2beta1IntentMessageMediaContent; /** * Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform. */ - payload?: {[key: string]: any}; + payload?: {[key: string]: any} | null; /** * Optional. The platform that this message is intended for. */ - platform?: string; + platform?: string | null; /** * Displays quick replies. */ quickReplies?: Schema$GoogleCloudDialogflowV2beta1IntentMessageQuickReplies; + /** + * Rich Business Messaging (RBM) carousel rich card response. + */ + rbmCarouselRichCard?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard; + /** + * Standalone Rich Business Messaging (RBM) rich card response. + */ + rbmStandaloneRichCard?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard; + /** + * Rich Business Messaging (RBM) text response. RBM allows businesses to send enriched and branded versions of SMS. See https://jibe.google.com/business-messaging. + */ + rbmText?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmText; /** * Returns a voice or text-only response for Actions on Google. */ @@ -534,6 +616,10 @@ export namespace dialogflow_v2 { * Displays suggestion chips for Actions on Google. */ suggestions?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSuggestions; + /** + * Table card for Actions on Google. + */ + tableCard?: Schema$GoogleCloudDialogflowV2beta1IntentMessageTableCard; /** * Plays audio from a file in Telephony Gateway. */ @@ -562,7 +648,7 @@ export namespace dialogflow_v2 { /** * Required, unless image is present. The body text of the card. */ - formattedText?: string; + formattedText?: string | null; /** * Optional. The image for the card. */ @@ -570,11 +656,11 @@ export namespace dialogflow_v2 { /** * Optional. The subtitle of the card. */ - subtitle?: string; + subtitle?: string | null; /** * Optional. The title of the card. */ - title?: string; + title?: string | null; } /** * The button object that appears at the bottom of a card. @@ -587,7 +673,7 @@ export namespace dialogflow_v2 { /** * Required. The title of the button. */ - title?: string; + title?: string | null; } /** * Opens the given URI. @@ -596,7 +682,58 @@ export namespace dialogflow_v2 { /** * Required. The HTTP or HTTPS scheme URI. */ - uri?: string; + uri?: string | null; + } + /** + * Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard { + /** + * Optional. Settings for displaying the image. Applies to every image in items. + */ + imageDisplayOptions?: string | null; + /** + * Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten. + */ + items?: Schema$GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem[]; + } + /** + * Browsing carousel tile + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem { + /** + * Optional. Description of the carousel item. Maximum of four lines of text. + */ + description?: string | null; + /** + * Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text. + */ + footer?: string | null; + /** + * Optional. Hero image for the carousel item. + */ + image?: Schema$GoogleCloudDialogflowV2beta1IntentMessageImage; + /** + * Required. Action to present to the user. + */ + openUriAction?: Schema$GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction; + /** + * Required. Title of the carousel item. Maximum of two lines of text. + */ + title?: string | null; + } + /** + * Actions on Google action to open a given url. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction { + /** + * Required. URL + */ + url?: string | null; + /** + * Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser. + */ + urlTypeHint?: string | null; } /** * The card response message. @@ -609,15 +746,15 @@ export namespace dialogflow_v2 { /** * Optional. The public URI to an image file for the card. */ - imageUri?: string; + imageUri?: string | null; /** * Optional. The subtitle of the card. */ - subtitle?: string; + subtitle?: string | null; /** * Optional. The title of the card. */ - title?: string; + title?: string | null; } /** * Optional. Contains information about a button. @@ -626,11 +763,11 @@ export namespace dialogflow_v2 { /** * Optional. The text to send back to the Dialogflow API or a URI to open. */ - postback?: string; + postback?: string | null; /** * Optional. The text to show on the button. */ - text?: string; + text?: string | null; } /** * The card for presenting a carousel of options to select from. @@ -648,7 +785,7 @@ export namespace dialogflow_v2 { /** * Optional. The body text of the card. */ - description?: string; + description?: string | null; /** * Optional. The image to display. */ @@ -660,7 +797,20 @@ export namespace dialogflow_v2 { /** * Required. Title of the carousel item. */ - title?: string; + title?: string | null; + } + /** + * Column properties for TableCard. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageColumnProperties { + /** + * Required. Column heading. + */ + header?: string | null; + /** + * Optional. Defines text alignment for all cells in this column. + */ + horizontalAlignment?: string | null; } /** * The image response message. @@ -669,11 +819,11 @@ export namespace dialogflow_v2 { /** * A text description of the image to be used for accessibility, e.g., screen readers. Required if image_uri is set for CarouselSelect. */ - accessibilityText?: string; + accessibilityText?: string | null; /** * Optional. The public URI to an image file. */ - imageUri?: string; + imageUri?: string | null; } /** * The suggestion chip message that allows the user to jump out to the app or website associated with this agent. @@ -682,11 +832,11 @@ export namespace dialogflow_v2 { /** * Required. The name of the app or site this chip is linking to. */ - destinationName?: string; + destinationName?: string | null; /** * Required. The URI of the app or site to open when the user taps the suggestion chip. */ - uri?: string; + uri?: string | null; } /** * The card for presenting a list of options to select from. @@ -696,10 +846,14 @@ export namespace dialogflow_v2 { * Required. List items. */ items?: Schema$GoogleCloudDialogflowV2beta1IntentMessageListSelectItem[]; + /** + * Optional. Subtitle of the list. + */ + subtitle?: string | null; /** * Optional. The overall title of the list. */ - title?: string; + title?: string | null; } /** * An item in the list. @@ -708,7 +862,7 @@ export namespace dialogflow_v2 { /** * Optional. The main text describing the item. */ - description?: string; + description?: string | null; /** * Optional. The image to display. */ @@ -720,7 +874,45 @@ export namespace dialogflow_v2 { /** * Required. The title of the list item. */ - title?: string; + title?: string | null; + } + /** + * The media content card for Actions on Google. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageMediaContent { + /** + * Required. List of media objects. + */ + mediaObjects?: Schema$GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject[]; + /** + * Optional. What type of media is the content (ie "audio"). + */ + mediaType?: string | null; + } + /** + * Response media object for media content card. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject { + /** + * Required. Url where the media is stored. + */ + contentUrl?: string | null; + /** + * Optional. Description of media card. + */ + description?: string | null; + /** + * Optional. Icon to display above media content. + */ + icon?: Schema$GoogleCloudDialogflowV2beta1IntentMessageImage; + /** + * Optional. Image to display above media content. + */ + largeImage?: Schema$GoogleCloudDialogflowV2beta1IntentMessageImage; + /** + * Required. Name of media card. + */ + name?: string | null; } /** * The quick replies response message. @@ -729,11 +921,165 @@ export namespace dialogflow_v2 { /** * Optional. The collection of quick replies. */ - quickReplies?: string[]; + quickReplies?: string[] | null; /** * Optional. The title of the collection of quick replies. */ - title?: string; + title?: string | null; + } + /** + * Rich Business Messaging (RBM) Card content + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent { + /** + * Optional. Description of the card (at most 2000 bytes). At least one of the title, description or media must be set. + */ + description?: string | null; + /** + * Optional. However at least one of the title, description or media must be set. Media (image, GIF or a video) to include in the card. + */ + media?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia; + /** + * Optional. List of suggestions to include in the card. + */ + suggestions?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion[]; + /** + * Optional. Title of the card (at most 200 bytes). At least one of the title, description or media must be set. + */ + title?: string | null; + } + /** + * Rich Business Messaging (RBM) Media displayed in Cards The following media-types are currently supported: ## Image Types image/jpeg image/jpg' image/gif image/png ## Video Types video/h263 video/m4v video/mp4 video/mpeg video/mpeg4 video/webm + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia { + /** + * Required. Publicly reachable URI of the file. The RBM platform determines the MIME type of the file from the content-type field in the HTTP headers when the platform fetches the file. The content-type field must be present and accurate in the HTTP response from the URL. + */ + fileUri?: string | null; + /** + * Required for cards with vertical orientation. The height of the media within a rich card with a vertical layout. (https://goo.gl/NeFCjz). For a standalone card with horizontal layout, height is not customizable, and this field is ignored. + */ + height?: string | null; + /** + * Optional. Publicly reachable URI of the thumbnail.If you don't provide a thumbnail URI, the RBM platform displays a blank placeholder thumbnail until the user's device downloads the file. Depending on the user's setting, the file may not download automatically and may require the user to tap a download button. + */ + thumbnailUri?: string | null; + } + /** + * Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. For more details about RBM rich cards, please see: https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards. If you want to show a single card with more control over the layout, please use RbmStandaloneCard instead. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard { + /** + * Required. The cards in the carousel. A carousel must have at least 2 cards and at most 10. + */ + cardContents?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent[]; + /** + * Required. The width of the cards in the carousel. + */ + cardWidth?: string | null; + } + /** + * Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to respond to users with more vivid content, e.g. with media and suggestions. For more details about RBM rich cards, please see: https://developers.google.com/rcs-business-messaging/rbm/guides/build/send-messages#rich-cards. You can group multiple rich cards into one using RbmCarouselCard but carousel cards will give you less control over the card layout. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard { + /** + * Required. Card content. + */ + cardContent?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent; + /** + * Required. Orientation of the card. + */ + cardOrientation?: string | null; + /** + * Required if orientation is horizontal. Image preview alignment for standalone cards with horizontal layout. + */ + thumbnailImageAlignment?: string | null; + } + /** + * Rich Business Messaging (RBM) suggested client-side action that the user can choose from the card. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction { + /** + * Suggested client side action: Dial a phone number + */ + dial?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial; + /** + * Suggested client side action: Open a URI on device + */ + openUrl?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri; + /** + * Opaque payload that the Dialogflow receives in a user event when the user taps the suggested action. This data will be also forwarded to webhook to allow performing custom business logic. + */ + postbackData?: string | null; + /** + * Suggested client side action: Share user location + */ + shareLocation?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation; + /** + * Text to display alongside the action. + */ + text?: string | null; + } + /** + * Opens the user's default dialer app with the specified phone number but does not dial automatically (https://goo.gl/ergbB2). + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial { + /** + * Required. The phone number to fill in the default dialer app. This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example of a correctly formatted phone number: +15556767888. + */ + phoneNumber?: string | null; + } + /** + * Opens the user's default web browser app to the specified uri (https://goo.gl/6GLJD2). If the user has an app installed that is registered as the default handler for the URL, then this app will be opened instead, and its icon will be used in the suggested action UI. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri { + /** + * Required. The uri to open on the user device + */ + uri?: string | null; + } + /** + * Opens the device's location chooser so the user can pick a location to send back to the agent (https://goo.gl/GXotJW). + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation {} + /** + * Rich Business Messaging (RBM) suggested reply that the user can click instead of typing in their own response. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply { + /** + * Opaque payload that the Dialogflow receives in a user event when the user taps the suggested reply. This data will be also forwarded to webhook to allow performing custom business logic. + */ + postbackData?: string | null; + /** + * Suggested reply text. + */ + text?: string | null; + } + /** + * Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily select/click a predefined response or perform an action (like opening a web uri). + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion { + /** + * Predefined client side actions that user can choose + */ + action?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction; + /** + * Predefined replies for user to select instead of typing + */ + reply?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply; + } + /** + * Rich Business Messaging (RBM) text response with suggestions. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmText { + /** + * Optional. One or more suggestions to show to the user. + */ + rbmSuggestion?: Schema$GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion[]; + /** + * Required. Text sent and displayed to the user. + */ + text?: string | null; } /** * Additional info about the select item for when it is triggered in a dialog. @@ -742,11 +1088,11 @@ export namespace dialogflow_v2 { /** * Required. A unique key that will be sent back to the agent if this response is given. */ - key?: string; + key?: string | null; /** * Optional. A list of synonyms that can also be used to trigger this item in dialog. */ - synonyms?: string[]; + synonyms?: string[] | null; } /** * The simple response message containing speech or text. @@ -755,15 +1101,15 @@ export namespace dialogflow_v2 { /** * Optional. The text to display. */ - displayText?: string; + displayText?: string | null; /** * One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. */ - ssml?: string; + ssml?: string | null; /** * One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. */ - textToSpeech?: string; + textToSpeech?: string | null; } /** * The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. @@ -781,7 +1127,7 @@ export namespace dialogflow_v2 { /** * Required. The text shown the in the suggestion chip. */ - title?: string; + title?: string | null; } /** * The collection of suggestions. @@ -792,6 +1138,57 @@ export namespace dialogflow_v2 { */ suggestions?: Schema$GoogleCloudDialogflowV2beta1IntentMessageSuggestion[]; } + /** + * Table card for Actions on Google. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTableCard { + /** + * Optional. List of buttons for the card. + */ + buttons?: Schema$GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton[]; + /** + * Optional. Display properties for the columns in this table. + */ + columnProperties?: Schema$GoogleCloudDialogflowV2beta1IntentMessageColumnProperties[]; + /** + * Optional. Image which should be displayed on the card. + */ + image?: Schema$GoogleCloudDialogflowV2beta1IntentMessageImage; + /** + * Optional. Rows in this table of data. + */ + rows?: Schema$GoogleCloudDialogflowV2beta1IntentMessageTableCardRow[]; + /** + * Optional. Subtitle to the title. + */ + subtitle?: string | null; + /** + * Required. Title of the card. + */ + title?: string | null; + } + /** + * Cell of TableCardRow. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTableCardCell { + /** + * Required. Text in this cell. + */ + text?: string | null; + } + /** + * Row of TableCard. + */ + export interface Schema$GoogleCloudDialogflowV2beta1IntentMessageTableCardRow { + /** + * Optional. List of cells that make up this row. + */ + cells?: Schema$GoogleCloudDialogflowV2beta1IntentMessageTableCardCell[]; + /** + * Optional. Whether to add a visual divider after this row. + */ + dividerAfter?: boolean | null; + } /** * Plays audio from a file in Telephony Gateway. */ @@ -799,7 +1196,7 @@ export namespace dialogflow_v2 { /** * Required. URI to a Google Cloud Storage object containing the audio to play, e.g., "gs://bucket/object". The object must contain a single channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by the `service-<Project Number>@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where <Project Number> is the number of the Telephony Gateway project (usually the same as the Dialogflow agent project). If the Google Cloud Storage bucket is in the Telephony Gateway project, this permission is added by default when enabling the Dialogflow V2 API. For audio from other sources, consider using the `TelephonySynthesizeSpeech` message with SSML. */ - audioUri?: string; + audioUri?: string | null; } /** * Synthesizes speech and plays back the synthesized audio to the caller in Telephony Gateway. Telephony Gateway takes the synthesizer settings from `DetectIntentResponse.output_audio_config` which can either be set at request-level or can come from the agent-level synthesizer config. @@ -808,11 +1205,11 @@ export namespace dialogflow_v2 { /** * The SSML to be synthesized. For more information, see [SSML](https://developers.google.com/actions/reference/ssml). */ - ssml?: string; + ssml?: string | null; /** * The raw text to be synthesized. */ - text?: string; + text?: string | null; } /** * Transfers the call in Telephony Gateway. @@ -821,7 +1218,7 @@ export namespace dialogflow_v2 { /** * Required. The phone number to transfer the call to in [E.164 format](https://en.wikipedia.org/wiki/E.164). We currently only allow transferring to US numbers (+1xxxyyyzzzz). */ - phoneNumber?: string; + phoneNumber?: string | null; } /** * The text response message. @@ -830,7 +1227,7 @@ export namespace dialogflow_v2 { /** * Optional. The collection of the agent's responses. */ - text?: string[]; + text?: string[] | null; } /** * Represents intent parameters. @@ -839,35 +1236,35 @@ export namespace dialogflow_v2 { /** * Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`. */ - defaultValue?: string; + defaultValue?: string | null; /** * Required. The name of the parameter. */ - displayName?: string; + displayName?: string | null; /** * Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided. */ - entityTypeDisplayName?: string; + entityTypeDisplayName?: string | null; /** * Optional. Indicates whether the parameter represents a list of values. */ - isList?: boolean; + isList?: boolean | null; /** * Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. */ - mandatory?: boolean; + mandatory?: boolean | null; /** * The unique identifier of this parameter. */ - name?: string; + name?: string | null; /** - * Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter. + * Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter. */ - prompts?: string[]; + prompts?: string[] | null; /** * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ - value?: string; + value?: string | null; } /** * Represents an example that the agent is trained on. @@ -876,7 +1273,7 @@ export namespace dialogflow_v2 { /** * Output only. The unique identifier of this training phrase. */ - name?: string; + name?: string | null; /** * Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set. */ @@ -884,11 +1281,11 @@ export namespace dialogflow_v2 { /** * Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. */ - timesAddedCount?: number; + timesAddedCount?: number | null; /** * Required. The type of the training phrase. */ - type?: string; + type?: string | null; } /** * Represents a part of a training phrase. @@ -897,19 +1294,19 @@ export namespace dialogflow_v2 { /** * Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase. */ - alias?: string; + alias?: string | null; /** * Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase. */ - entityType?: string; + entityType?: string | null; /** * Required. The text for this part. */ - text?: string; + text?: string | null; /** * Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true. */ - userDefined?: boolean; + userDefined?: boolean | null; } /** * Represents the result of querying a Knowledge base. @@ -927,23 +1324,23 @@ export namespace dialogflow_v2 { /** * The piece of text from the `source` knowledge base document that answers this conversational query. */ - answer?: string; + answer?: string | null; /** * The corresponding FAQ question if the answer was extracted from a FAQ Document, empty otherwise. */ - faqQuestion?: string; + faqQuestion?: string | null; /** * The system's confidence score that this Knowledge answer is a good match for this conversational query. The range is from 0.0 (completely uncertain) to 1.0 (completely certain). Note: The confidence score is likely to vary somewhat (possibly even for identical requests), as the underlying model is under constant improvement. It may be deprecated in the future. We recommend using `match_confidence_level` which should be generally more stable. */ - matchConfidence?: number; + matchConfidence?: number | null; /** * The system's confidence level that this knowledge answer is a good match for this conversational query. NOTE: The confidence level for a given `<query, answer>` pair may change without notice, as it depends on models that are constantly being improved. However, it will change less frequently than the confidence score below, and should be preferred for referencing the quality of an answer. */ - matchConfidenceLevel?: string; + matchConfidenceLevel?: string | null; /** * Indicates which Knowledge Document this answer was extracted from. Format: `projects/<Project ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`. */ - source?: string; + source?: string | null; } /** * Metadata in google::longrunning::Operation for Knowledge operations. @@ -952,7 +1349,16 @@ export namespace dialogflow_v2 { /** * Required. The current state of this operation. */ - state?: string; + state?: string | null; + } + /** + * The response for ConversationDatasets.LabelConversation. + */ + export interface Schema$GoogleCloudDialogflowV2beta1LabelConversationResponse { + /** + * New annotated conversation dataset created by the labeling task. + */ + annotatedConversationDataset?: Schema$GoogleCloudDialogflowV2beta1AnnotatedConversationDataset; } /** * Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call. @@ -961,15 +1367,15 @@ export namespace dialogflow_v2 { /** * Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be redacted for Standard Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. */ - payload?: {[key: string]: any}; + payload?: {[key: string]: any} | null; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers. */ - source?: string; + source?: string | null; /** * Optional. The version of the protocol used for this request. This field is AoG-specific. */ - version?: string; + version?: string | null; } /** * Represents the result of conversational query or event processing. @@ -978,15 +1384,15 @@ export namespace dialogflow_v2 { /** * The action name from the matched intent. */ - action?: string; + action?: string | null; /** - * This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. + * This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. */ - allRequiredParamsPresent?: boolean; + allRequiredParamsPresent?: boolean | null; /** - * The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice. + * Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors */ - diagnosticInfo?: {[key: string]: any}; + diagnosticInfo?: {[key: string]: any} | null; /** * The collection of rich messages to present to the user. */ @@ -994,23 +1400,23 @@ export namespace dialogflow_v2 { /** * The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred. */ - fulfillmentText?: string; + fulfillmentText?: string | null; /** - * The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`. + * The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`. */ intent?: Schema$GoogleCloudDialogflowV2beta1Intent; /** - * The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. + * The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. */ - intentDetectionConfidence?: number; + intentDetectionConfidence?: number | null; /** * The result from Knowledge Connector (if any), ordered by decreasing `KnowledgeAnswers.match_confidence`. */ knowledgeAnswers?: Schema$GoogleCloudDialogflowV2beta1KnowledgeAnswers; /** - * The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. + * The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `<parameter name>.original` containing the original parameter values before the query. */ @@ -1018,11 +1424,11 @@ export namespace dialogflow_v2 { /** * The collection of extracted parameters. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; /** - * The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set. + * The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input. */ - queryText?: string; + queryText?: string | null; /** * The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request. */ @@ -1030,15 +1436,15 @@ export namespace dialogflow_v2 { /** * The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. */ - speechRecognitionConfidence?: number; + speechRecognitionConfidence?: number | null; /** * If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response. */ - webhookPayload?: {[key: string]: any}; + webhookPayload?: {[key: string]: any} | null; /** * If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response. */ - webhookSource?: string; + webhookSource?: string | null; } /** * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. @@ -1047,11 +1453,11 @@ export namespace dialogflow_v2 { /** * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */ - magnitude?: number; + magnitude?: number | null; /** * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ - score?: number; + score?: number | null; } /** * The result of sentiment analysis as configured by `sentiment_analysis_request_config`. @@ -1062,6 +1468,23 @@ export namespace dialogflow_v2 { */ queryTextSentiment?: Schema$GoogleCloudDialogflowV2beta1Sentiment; } + /** + * Represents a session entity type. Extends or replaces a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. + */ + export interface Schema$GoogleCloudDialogflowV2beta1SessionEntityType { + /** + * Required. The collection of entities associated with this session entity type. + */ + entities?: Schema$GoogleCloudDialogflowV2beta1EntityTypeEntity[]; + /** + * Required. Indicates whether the additional data should override or supplement the custom entity type definition. + */ + entityOverrideMode?: string | null; + /** + * Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. If `Environment ID` is not specified, we assume default 'draft' environment. If `User ID` is not specified, we assume default '-' user. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. + */ + name?: string | null; + } /** * The request message for a webhook call. */ @@ -1081,22 +1504,22 @@ export namespace dialogflow_v2 { /** * The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`. */ - responseId?: string; + responseId?: string | null; /** * The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. */ - session?: string; + session?: string | null; } /** - * The response message for a webhook call. + * The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `""` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). */ export interface Schema$GoogleCloudDialogflowV2beta1WebhookResponse { /** * Optional. Indicates that this intent ends an interaction. Some integrations (e.g., Actions on Google or Dialogflow phone gateway) use this information to close interaction with an end user. Default is false. */ - endInteraction?: boolean; + endInteraction?: boolean | null; /** - * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. + * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. */ followupEventInput?: Schema$GoogleCloudDialogflowV2beta1EventInput; /** @@ -1106,7 +1529,7 @@ export namespace dialogflow_v2 { /** * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. */ - fulfillmentText?: string; + fulfillmentText?: string | null; /** * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. */ @@ -1114,11 +1537,15 @@ export namespace dialogflow_v2 { /** * Optional. This value is passed directly to `QueryResult.webhook_payload`. See the related `fulfillment_messages[i].payload field`, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre> */ - payload?: {[key: string]: any}; + payload?: {[key: string]: any} | null; + /** + * Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. Setting the session entity types inside webhook overwrites the session entity types that have been set through `DetectIntentRequest.query_params.session_entity_types`. + */ + sessionEntityTypes?: Schema$GoogleCloudDialogflowV2beta1SessionEntityType[]; /** * Optional. This value is passed directly to `QueryResult.webhook_source`. */ - source?: string; + source?: string | null; } /** * Represents a context. @@ -1127,36 +1554,61 @@ export namespace dialogflow_v2 { /** * Optional. The number of conversational query requests after which the context expires. If set to `0` (the default) the context expires immediately. Contexts expire automatically after 20 minutes if there are no matching queries. */ - lifespanCount?: number; + lifespanCount?: number | null; /** - * Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. + * Required. The unique identifier of the context. Format: `projects/<Project ID>/agent/sessions/<Session ID>/contexts/<Context ID>`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` */ - name?: string; + name?: string | null; /** - * Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow-enterprise/docs/intents-actions-parameters) for syntax. + * Optional. The collection of parameters associated with this context. Refer to [this doc](https://cloud.google.com/dialogflow/docs/intents-actions-parameters) for syntax. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; } /** - * The request to detect user's intent. + * Represents a notification sent to Cloud Pub/Sub subscribers for conversation lifecycle events. */ - export interface Schema$GoogleCloudDialogflowV2DetectIntentRequest { + export interface Schema$GoogleCloudDialogflowV2ConversationEvent { /** - * Optional. The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data. + * The unique identifier of the conversation this notification refers to. Format: `projects/<Project ID>/conversations/<Conversation ID>`. */ - inputAudio?: string; + conversation?: string | null; /** - * Optional. Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated. + * More detailed information about an error. Only set for type UNRECOVERABLE_ERROR_IN_PHONE_CALL. */ - outputAudioConfig?: Schema$GoogleCloudDialogflowV2OutputAudioConfig; + errorStatus?: Schema$GoogleRpcStatus; /** - * Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger. + * Payload of NEW_MESSAGE event. */ - queryInput?: Schema$GoogleCloudDialogflowV2QueryInput; + newMessagePayload?: Schema$GoogleCloudDialogflowV2Message; /** - * Optional. The parameters of this query. + * The type of the event that this notification refers to. */ - queryParams?: Schema$GoogleCloudDialogflowV2QueryParameters; + type?: string | null; + } + /** + * ============================================================================ Requests and responses for custom methods. The request to detect user's intent. + */ + export interface Schema$GoogleCloudDialogflowV2DetectIntentRequest { + /** + * The natural language speech audio to be processed. This field should be populated iff `query_input` is set to an input audio config. A single request can contain up to 1 minute of speech audio data. + */ + inputAudio?: string | null; + /** + * Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated. + */ + outputAudioConfig?: Schema$GoogleCloudDialogflowV2OutputAudioConfig; + /** + * Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level. If unspecified or empty, output_audio_config replaces the agent-level config in its entirety. + */ + outputAudioConfigMask?: string | null; + /** + * Required. The input specification. It can be set to: 1. an audio config which instructs the speech recognizer how to process the speech audio, 2. a conversational query in the form of text, or 3. an event that specifies which intent to trigger. + */ + queryInput?: Schema$GoogleCloudDialogflowV2QueryInput; + /** + * The parameters of this query. + */ + queryParams?: Schema$GoogleCloudDialogflowV2QueryParameters; } /** * The message returned from the DetectIntent method. @@ -1165,7 +1617,7 @@ export namespace dialogflow_v2 { /** * The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the `query_result.fulfillment_messages` field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty. */ - outputAudio?: string; + outputAudio?: string | null; /** * The config used by the speech synthesizer to generate the output audio. */ @@ -1177,7 +1629,7 @@ export namespace dialogflow_v2 { /** * The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues. */ - responseId?: string; + responseId?: string | null; /** * Specifies the status of the webhook request. */ @@ -1190,11 +1642,15 @@ export namespace dialogflow_v2 { /** * Optional. Indicates whether the entity type can be automatically expanded. */ - autoExpansionMode?: string; + autoExpansionMode?: string | null; /** * Required. The name of the entity type. */ - displayName?: string; + displayName?: string | null; + /** + * Optional. Enables fuzzy entity extraction during classification. + */ + enableFuzzyExtraction?: boolean | null; /** * Optional. The collection of entity entries associated with the entity type. */ @@ -1202,11 +1658,11 @@ export namespace dialogflow_v2 { /** * Required. Indicates the kind of entity type. */ - kind?: string; + kind?: string | null; /** * The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`. */ - name?: string; + name?: string | null; } /** * This message is a wrapper around a collection of entity types. @@ -1224,63 +1680,122 @@ export namespace dialogflow_v2 { /** * Required. A collection of value synonyms. For example, if the entity type is *vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For `KIND_LIST` entity types: * This collection must contain exactly one synonym equal to `value`. */ - synonyms?: string[]; + synonyms?: string[] | null; /** - * Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A canonical value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). + * Required. The primary value associated with this entity entry. For example, if the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` entity types: * A reference value to be used in place of synonyms. For `KIND_LIST` entity types: * A string that can contain references to other entity types (with or without aliases). */ - value?: string; + value?: string | null; } /** * Events allow for matching intents by event name instead of the natural language input. For instance, input `<event: { name: "welcome_event", parameters: { name: "Sam" } }>` can trigger a personalized welcome response. The parameter `name` may be used by the agent in the response: `"Hello #welcome_event.name! What can I do for you today?"`. */ export interface Schema$GoogleCloudDialogflowV2EventInput { /** - * Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + * Required. The language of this query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ - languageCode?: string; + languageCode?: string | null; /** * Required. The unique identifier of the event. */ - name?: string; + name?: string | null; /** - * Optional. The collection of parameters associated with the event. + * The collection of parameters associated with the event. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; } /** * The request message for Agents.ExportAgent. */ export interface Schema$GoogleCloudDialogflowV2ExportAgentRequest { /** - * Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized agent is returned inline. + * Required. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the agent to. The format of this URI must be `gs://<bucket-name>/<object-name>`. If left unspecified, the serialized agent is returned inline. */ - agentUri?: string; + agentUri?: string | null; } /** * The response message for Agents.ExportAgent. */ export interface Schema$GoogleCloudDialogflowV2ExportAgentResponse { /** - * The exported agent. Example for how to export an agent to a zip file via a command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:export'\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary '{}' \ | grep agentContent | sed -e 's/.*"agentContent": "\([^"]*\)".x/\1/' \ | base64 --decode > &lt;agent zip file&gt;</pre> + * Zip compressed raw byte content for agent. */ - agentContent?: string; + agentContent?: string | null; /** * The URI to a file containing the exported agent. This field is populated only if `agent_uri` is specified in `ExportAgentRequest`. */ - agentUri?: string; + agentUri?: string | null; + } + /** + * Represents a fulfillment. + */ + export interface Schema$GoogleCloudDialogflowV2Fulfillment { + /** + * Optional. The human-readable name of the fulfillment, unique within the agent. + */ + displayName?: string | null; + /** + * Optional. Whether fulfillment is enabled. + */ + enabled?: boolean | null; + /** + * Optional. The field defines whether the fulfillment is enabled for certain features. + */ + features?: Schema$GoogleCloudDialogflowV2FulfillmentFeature[]; + /** + * Configuration for a generic web service. + */ + genericWebService?: Schema$GoogleCloudDialogflowV2FulfillmentGenericWebService; + /** + * Required. The unique identifier of the fulfillment. Format: `projects/<Project ID>/agent/fulfillment`. + */ + name?: string | null; + } + /** + * Whether fulfillment is enabled for the specific feature. + */ + export interface Schema$GoogleCloudDialogflowV2FulfillmentFeature { + /** + * The type of the feature that enabled for fulfillment. + */ + type?: string | null; + } + /** + * Represents configuration for a generic web service. Dialogflow supports two mechanisms for authentications: - Basic authentication with username and password. - Authentication with additional authentication headers. More information could be found at: https://cloud.google.com/dialogflow/docs/fulfillment-configure. + */ + export interface Schema$GoogleCloudDialogflowV2FulfillmentGenericWebService { + /** + * Optional. Indicates if generic web service is created through Cloud Functions integration. Defaults to false. + */ + isCloudFunction?: boolean | null; + /** + * Optional. The password for HTTP Basic authentication. + */ + password?: string | null; + /** + * Optional. The HTTP request headers to send together with fulfillment requests. + */ + requestHeaders?: {[key: string]: string} | null; + /** + * Required. The fulfillment URI for receiving POST requests. + */ + uri?: string | null; + /** + * Optional. The user name for HTTP Basic authentication. + */ + username?: string | null; } /** * The request message for Agents.ImportAgent. */ export interface Schema$GoogleCloudDialogflowV2ImportAgentRequest { /** - * The agent to import. Example for how to import an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:import\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)' }"</pre> + * Zip compressed raw byte content for agent. */ - agentContent?: string; + agentContent?: string | null; /** * The URI to a Google Cloud Storage file containing the agent to import. Note: The URI must start with "gs://". */ - agentUri?: string; + agentUri?: string | null; } /** * Instructs the speech recognizer how to process the audio content. @@ -1289,23 +1804,39 @@ export namespace dialogflow_v2 { /** * Required. Audio encoding of the audio content to process. */ - audioEncoding?: string; + audioEncoding?: string | null; /** - * Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + * Optional. If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. */ - languageCode?: string; + enableWordInfo?: boolean | null; + /** + * Required. The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + */ + languageCode?: string | null; + /** + * Optional. Which Speech model to select for the given request. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then we auto-select a model based on the parameters in the InputAudioConfig. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. + */ + model?: string | null; /** * Optional. Which variant of the Speech model to use. */ - modelVariant?: string; + modelVariant?: string | null; /** - * Optional. The collection of phrase hints which are used to boost accuracy of speech recognition. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. + * Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [speech_contexts]() instead. If you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will treat the [phrase_hints]() as a single additional [SpeechContext](). */ - phraseHints?: string[]; + phraseHints?: string[] | null; /** * Required. Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. */ - sampleRateHertz?: number; + sampleRateHertz?: number | null; + /** + * Optional. If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. + */ + singleUtterance?: boolean | null; + /** + * Optional. Context information to assist speech recognition. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. + */ + speechContexts?: Schema$GoogleCloudDialogflowV2SpeechContext[]; } /** * Represents an intent. Intents convert a number of user expressions or patterns into an action. An action is an extraction of a user command or sentence semantics. @@ -1314,19 +1845,19 @@ export namespace dialogflow_v2 { /** * Optional. The name of the action associated with the intent. Note: The action name must not contain whitespaces. */ - action?: string; + action?: string | null; /** - * Optional. The list of platforms for which the first response will be taken from among the messages assigned to the DEFAULT_PLATFORM. + * Optional. The list of platforms for which the first responses will be copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). */ - defaultResponsePlatforms?: string[]; + defaultResponsePlatforms?: string[] | null; /** * Required. The name of this intent. */ - displayName?: string; + displayName?: string | null; /** * Optional. The collection of event names that trigger the intent. If the collection of input contexts is not empty, all of the contexts must be present in the active user session for an event to trigger this intent. */ - events?: string[]; + events?: string[] | null; /** * Read-only. Information about all followup intents that have this intent as a direct or indirect parent. We populate this field only in the output. */ @@ -1334,23 +1865,23 @@ export namespace dialogflow_v2 { /** * Optional. The list of context names required for this intent to be triggered. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ - inputContextNames?: string[]; + inputContextNames?: string[] | null; /** * Optional. Indicates whether this is a fallback intent. */ - isFallback?: boolean; + isFallback?: boolean | null; /** * Optional. The collection of rich messages corresponding to the `Response` field in the Dialogflow console. */ messages?: Schema$GoogleCloudDialogflowV2IntentMessage[]; /** - * Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_diabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. + * Optional. Indicates whether Machine Learning is disabled for the intent. Note: If `ml_disabled` setting is set to true, then this intent is not taken into account during inference in `ML ONLY` match mode. Also, auto-markup in the UI is turned off. */ - mlDisabled?: boolean; + mlDisabled?: boolean | null; /** * The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - name?: string; + name?: string | null; /** * Optional. The collection of contexts that are activated when the intent is matched. Context messages in this collection should not set the parameters field. Setting the `lifespan_count` to 0 will reset the context when the intent is matched. Format: `projects/<Project ID>/agent/sessions/-/contexts/<Context ID>`. */ @@ -1362,19 +1893,19 @@ export namespace dialogflow_v2 { /** * Read-only after creation. The unique identifier of the parent intent in the chain of followup intents. You can set this field when creating an intent, for example with CreateIntent or BatchUpdateIntents, in order to make this intent a followup intent. It identifies the parent followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - parentFollowupIntentName?: string; + parentFollowupIntentName?: string | null; /** - * Optional. The priority of this intent. Higher numbers represent higher priorities. If this is zero or unspecified, we use the default priority 500000. Negative numbers mean that the intent is disabled. + * Optional. The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. */ - priority?: number; + priority?: number | null; /** * Optional. Indicates whether to delete all contexts in the current session when this intent is matched. */ - resetContexts?: boolean; + resetContexts?: boolean | null; /** * Read-only. The unique identifier of the root intent in the chain of followup intents. It identifies the correct followup intents chain for this intent. We populate this field only in the output. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - rootFollowupIntentName?: string; + rootFollowupIntentName?: string | null; /** * Optional. The collection of examples that the agent is trained on. */ @@ -1382,7 +1913,7 @@ export namespace dialogflow_v2 { /** * Optional. Indicates whether webhooks are enabled for the intent. */ - webhookState?: string; + webhookState?: string | null; } /** * This message is a wrapper around a collection of intents. @@ -1400,11 +1931,11 @@ export namespace dialogflow_v2 { /** * The unique identifier of the followup intent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - followupIntentName?: string; + followupIntentName?: string | null; /** * The unique identifier of the followup intent's parent. Format: `projects/<Project ID>/agent/intents/<Intent ID>`. */ - parentFollowupIntentName?: string; + parentFollowupIntentName?: string | null; } /** * Corresponds to the `Response` field in the Dialogflow console. @@ -1414,6 +1945,10 @@ export namespace dialogflow_v2 { * The basic card response for Actions on Google. */ basicCard?: Schema$GoogleCloudDialogflowV2IntentMessageBasicCard; + /** + * Browse carousel card for Actions on Google. + */ + browseCarouselCard?: Schema$GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard; /** * The card response. */ @@ -1434,14 +1969,18 @@ export namespace dialogflow_v2 { * The list card response for Actions on Google. */ listSelect?: Schema$GoogleCloudDialogflowV2IntentMessageListSelect; + /** + * The media content card for Actions on Google. + */ + mediaContent?: Schema$GoogleCloudDialogflowV2IntentMessageMediaContent; /** * Returns a response containing a custom, platform-specific payload. See the Intent.Message.Platform type for a description of the structure that may be required for your platform. */ - payload?: {[key: string]: any}; + payload?: {[key: string]: any} | null; /** * Optional. The platform that this message is intended for. */ - platform?: string; + platform?: string | null; /** * The quick replies response. */ @@ -1454,6 +1993,10 @@ export namespace dialogflow_v2 { * The suggestion chips for Actions on Google. */ suggestions?: Schema$GoogleCloudDialogflowV2IntentMessageSuggestions; + /** + * Table card for Actions on Google. + */ + tableCard?: Schema$GoogleCloudDialogflowV2IntentMessageTableCard; /** * The text response. */ @@ -1470,7 +2013,7 @@ export namespace dialogflow_v2 { /** * Required, unless image is present. The body text of the card. */ - formattedText?: string; + formattedText?: string | null; /** * Optional. The image for the card. */ @@ -1478,11 +2021,11 @@ export namespace dialogflow_v2 { /** * Optional. The subtitle of the card. */ - subtitle?: string; + subtitle?: string | null; /** * Optional. The title of the card. */ - title?: string; + title?: string | null; } /** * The button object that appears at the bottom of a card. @@ -1495,7 +2038,7 @@ export namespace dialogflow_v2 { /** * Required. The title of the button. */ - title?: string; + title?: string | null; } /** * Opens the given URI. @@ -1504,7 +2047,58 @@ export namespace dialogflow_v2 { /** * Required. The HTTP or HTTPS scheme URI. */ - uri?: string; + uri?: string | null; + } + /** + * Browse Carousel Card for Actions on Google. https://developers.google.com/actions/assistant/responses#browsing_carousel + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard { + /** + * Optional. Settings for displaying the image. Applies to every image in items. + */ + imageDisplayOptions?: string | null; + /** + * Required. List of items in the Browse Carousel Card. Minimum of two items, maximum of ten. + */ + items?: Schema$GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem[]; + } + /** + * Browsing carousel tile + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem { + /** + * Optional. Description of the carousel item. Maximum of four lines of text. + */ + description?: string | null; + /** + * Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum of one line of text. + */ + footer?: string | null; + /** + * Optional. Hero image for the carousel item. + */ + image?: Schema$GoogleCloudDialogflowV2IntentMessageImage; + /** + * Required. Action to present to the user. + */ + openUriAction?: Schema$GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction; + /** + * Required. Title of the carousel item. Maximum of two lines of text. + */ + title?: string | null; + } + /** + * Actions on Google action to open a given url. + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction { + /** + * Required. URL + */ + url?: string | null; + /** + * Optional. Specifies the type of viewer that is used when opening the URL. Defaults to opening via web browser. + */ + urlTypeHint?: string | null; } /** * The card response message. @@ -1517,28 +2111,28 @@ export namespace dialogflow_v2 { /** * Optional. The public URI to an image file for the card. */ - imageUri?: string; + imageUri?: string | null; /** * Optional. The subtitle of the card. */ - subtitle?: string; + subtitle?: string | null; /** * Optional. The title of the card. */ - title?: string; + title?: string | null; } /** - * Optional. Contains information about a button. + * Contains information about a button. */ export interface Schema$GoogleCloudDialogflowV2IntentMessageCardButton { /** * Optional. The text to send back to the Dialogflow API or a URI to open. */ - postback?: string; + postback?: string | null; /** * Optional. The text to show on the button. */ - text?: string; + text?: string | null; } /** * The card for presenting a carousel of options to select from. @@ -1556,7 +2150,7 @@ export namespace dialogflow_v2 { /** * Optional. The body text of the card. */ - description?: string; + description?: string | null; /** * Optional. The image to display. */ @@ -1568,7 +2162,20 @@ export namespace dialogflow_v2 { /** * Required. Title of the carousel item. */ - title?: string; + title?: string | null; + } + /** + * Column properties for TableCard. + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageColumnProperties { + /** + * Required. Column heading. + */ + header?: string | null; + /** + * Optional. Defines text alignment for all cells in this column. + */ + horizontalAlignment?: string | null; } /** * The image response message. @@ -1577,11 +2184,11 @@ export namespace dialogflow_v2 { /** * Optional. A text description of the image to be used for accessibility, e.g., screen readers. */ - accessibilityText?: string; + accessibilityText?: string | null; /** * Optional. The public URI to an image file. */ - imageUri?: string; + imageUri?: string | null; } /** * The suggestion chip message that allows the user to jump out to the app or website associated with this agent. @@ -1590,11 +2197,11 @@ export namespace dialogflow_v2 { /** * Required. The name of the app or site this chip is linking to. */ - destinationName?: string; + destinationName?: string | null; /** * Required. The URI of the app or site to open when the user taps the suggestion chip. */ - uri?: string; + uri?: string | null; } /** * The card for presenting a list of options to select from. @@ -1604,10 +2211,14 @@ export namespace dialogflow_v2 { * Required. List items. */ items?: Schema$GoogleCloudDialogflowV2IntentMessageListSelectItem[]; + /** + * Optional. Subtitle of the list. + */ + subtitle?: string | null; /** * Optional. The overall title of the list. */ - title?: string; + title?: string | null; } /** * An item in the list. @@ -1616,7 +2227,7 @@ export namespace dialogflow_v2 { /** * Optional. The main text describing the item. */ - description?: string; + description?: string | null; /** * Optional. The image to display. */ @@ -1628,7 +2239,45 @@ export namespace dialogflow_v2 { /** * Required. The title of the list item. */ - title?: string; + title?: string | null; + } + /** + * The media content card for Actions on Google. + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageMediaContent { + /** + * Required. List of media objects. + */ + mediaObjects?: Schema$GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject[]; + /** + * Optional. What type of media is the content (ie "audio"). + */ + mediaType?: string | null; + } + /** + * Response media object for media content card. + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject { + /** + * Required. Url where the media is stored. + */ + contentUrl?: string | null; + /** + * Optional. Description of media card. + */ + description?: string | null; + /** + * Optional. Icon to display above media content. + */ + icon?: Schema$GoogleCloudDialogflowV2IntentMessageImage; + /** + * Optional. Image to display above media content. + */ + largeImage?: Schema$GoogleCloudDialogflowV2IntentMessageImage; + /** + * Required. Name of media card. + */ + name?: string | null; } /** * The quick replies response message. @@ -1637,11 +2286,11 @@ export namespace dialogflow_v2 { /** * Optional. The collection of quick replies. */ - quickReplies?: string[]; + quickReplies?: string[] | null; /** * Optional. The title of the collection of quick replies. */ - title?: string; + title?: string | null; } /** * Additional info about the select item for when it is triggered in a dialog. @@ -1650,11 +2299,11 @@ export namespace dialogflow_v2 { /** * Required. A unique key that will be sent back to the agent if this response is given. */ - key?: string; + key?: string | null; /** * Optional. A list of synonyms that can also be used to trigger this item in dialog. */ - synonyms?: string[]; + synonyms?: string[] | null; } /** * The simple response message containing speech or text. @@ -1663,15 +2312,15 @@ export namespace dialogflow_v2 { /** * Optional. The text to display. */ - displayText?: string; + displayText?: string | null; /** * One of text_to_speech or ssml must be provided. Structured spoken response to the user in the SSML format. Mutually exclusive with text_to_speech. */ - ssml?: string; + ssml?: string | null; /** * One of text_to_speech or ssml must be provided. The plain text of the speech output. Mutually exclusive with ssml. */ - textToSpeech?: string; + textToSpeech?: string | null; } /** * The collection of simple response candidates. This message in `QueryResult.fulfillment_messages` and `WebhookResponse.fulfillment_messages` should contain only one `SimpleResponse`. @@ -1689,7 +2338,7 @@ export namespace dialogflow_v2 { /** * Required. The text shown the in the suggestion chip. */ - title?: string; + title?: string | null; } /** * The collection of suggestions. @@ -1700,6 +2349,57 @@ export namespace dialogflow_v2 { */ suggestions?: Schema$GoogleCloudDialogflowV2IntentMessageSuggestion[]; } + /** + * Table card for Actions on Google. + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageTableCard { + /** + * Optional. List of buttons for the card. + */ + buttons?: Schema$GoogleCloudDialogflowV2IntentMessageBasicCardButton[]; + /** + * Optional. Display properties for the columns in this table. + */ + columnProperties?: Schema$GoogleCloudDialogflowV2IntentMessageColumnProperties[]; + /** + * Optional. Image which should be displayed on the card. + */ + image?: Schema$GoogleCloudDialogflowV2IntentMessageImage; + /** + * Optional. Rows in this table of data. + */ + rows?: Schema$GoogleCloudDialogflowV2IntentMessageTableCardRow[]; + /** + * Optional. Subtitle to the title. + */ + subtitle?: string | null; + /** + * Required. Title of the card. + */ + title?: string | null; + } + /** + * Cell of TableCardRow. + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageTableCardCell { + /** + * Required. Text in this cell. + */ + text?: string | null; + } + /** + * Row of TableCard. + */ + export interface Schema$GoogleCloudDialogflowV2IntentMessageTableCardRow { + /** + * Optional. List of cells that make up this row. + */ + cells?: Schema$GoogleCloudDialogflowV2IntentMessageTableCardCell[]; + /** + * Optional. Whether to add a visual divider after this row. + */ + dividerAfter?: boolean | null; + } /** * The text response message. */ @@ -1707,7 +2407,7 @@ export namespace dialogflow_v2 { /** * Optional. The collection of the agent's responses. */ - text?: string[]; + text?: string[] | null; } /** * Represents intent parameters. @@ -1716,35 +2416,35 @@ export namespace dialogflow_v2 { /** * Optional. The default value to use when the `value` yields an empty result. Default values can be extracted from contexts by using the following syntax: `#context_name.parameter_name`. */ - defaultValue?: string; + defaultValue?: string | null; /** * Required. The name of the parameter. */ - displayName?: string; + displayName?: string | null; /** * Optional. The name of the entity type, prefixed with `@`, that describes values of the parameter. If the parameter is required, this must be provided. */ - entityTypeDisplayName?: string; + entityTypeDisplayName?: string | null; /** * Optional. Indicates whether the parameter represents a list of values. */ - isList?: boolean; + isList?: boolean | null; /** * Optional. Indicates whether the parameter is required. That is, whether the intent cannot be completed without collecting the parameter value. */ - mandatory?: boolean; + mandatory?: boolean | null; /** * The unique identifier of this parameter. */ - name?: string; + name?: string | null; /** - * Optional. The collection of prompts that the agent can present to the user in order to collect value for the parameter. + * Optional. The collection of prompts that the agent can present to the user in order to collect a value for the parameter. */ - prompts?: string[]; + prompts?: string[] | null; /** * Optional. The definition of the parameter value. It can be: - a constant string, - a parameter value defined as `$parameter_name`, - an original parameter value defined as `$parameter_name.original`, - a parameter value from some context defined as `#context_name.parameter_name`. */ - value?: string; + value?: string | null; } /** * Represents an example that the agent is trained on. @@ -1753,7 +2453,7 @@ export namespace dialogflow_v2 { /** * Output only. The unique identifier of this training phrase. */ - name?: string; + name?: string | null; /** * Required. The ordered list of training phrase parts. The parts are concatenated in order to form the training phrase. Note: The API does not automatically annotate training phrases like the Dialogflow Console does. Note: Do not forget to include whitespace at part boundaries, so the training phrase is well formatted when the parts are concatenated. If the training phrase does not need to be annotated with parameters, you just need a single part with only the Part.text field set. If you want to annotate the training phrase, you must create multiple parts, where the fields of each part are populated in one of two ways: - `Part.text` is set to a part of the phrase that has no parameters. - `Part.text` is set to a part of the phrase that you want to annotate, and the `entity_type`, `alias`, and `user_defined` fields are all set. */ @@ -1761,11 +2461,11 @@ export namespace dialogflow_v2 { /** * Optional. Indicates how many times this example was added to the intent. Each time a developer adds an existing sample by editing an intent or training, this counter is increased. */ - timesAddedCount?: number; + timesAddedCount?: number | null; /** * Required. The type of the training phrase. */ - type?: string; + type?: string | null; } /** * Represents a part of a training phrase. @@ -1774,19 +2474,19 @@ export namespace dialogflow_v2 { /** * Optional. The parameter name for the value extracted from the annotated part of the example. This field is required for annotated parts of the training phrase. */ - alias?: string; + alias?: string | null; /** * Optional. The entity type name prefixed with `@`. This field is required for annotated parts of the training phrase. */ - entityType?: string; + entityType?: string | null; /** * Required. The text for this part. */ - text?: string; + text?: string | null; /** * Optional. Indicates whether the text was manually annotated. This field is set to true when the Dialogflow Console is used to manually annotate the part. When creating an annotated part with the API, you must set this to true. */ - userDefined?: boolean; + userDefined?: boolean | null; } /** * The response message for Contexts.ListContexts. @@ -1799,7 +2499,7 @@ export namespace dialogflow_v2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for EntityTypes.ListEntityTypes. @@ -1812,7 +2512,7 @@ export namespace dialogflow_v2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for Intents.ListIntents. @@ -1825,7 +2525,7 @@ export namespace dialogflow_v2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The response message for SessionEntityTypes.ListSessionEntityTypes. @@ -1834,12 +2534,58 @@ export namespace dialogflow_v2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; /** * The list of session entity types. There will be a maximum number of items returned based on the page_size field in the request. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2SessionEntityType[]; } + /** + * Represents a message posted into a conversation. + */ + export interface Schema$GoogleCloudDialogflowV2Message { + /** + * Required. The message content. + */ + content?: string | null; + /** + * Output only. The time when the message was created. + */ + createTime?: string | null; + /** + * Optional. The message language. This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". + */ + languageCode?: string | null; + /** + * Output only. The annotation for the message. + */ + messageAnnotation?: Schema$GoogleCloudDialogflowV2MessageAnnotation; + /** + * The unique identifier of the message. Format: `projects/<Project ID>/conversations/<Conversation ID>/messages/<Message ID>`. + */ + name?: string | null; + /** + * Output only. The participant that sends this message. + */ + participant?: string | null; + /** + * Output only. The role of the participant. + */ + participantRole?: string | null; + } + /** + * Represents the result of annotation for the message. + */ + export interface Schema$GoogleCloudDialogflowV2MessageAnnotation { + /** + * Indicates whether the text message contains entities. + */ + containEntities?: boolean | null; + /** + * The collection of annotated message parts ordered by their position in the message. You can recover the annotated message by concatenating [AnnotatedMessagePart.text]. + */ + parts?: Schema$GoogleCloudDialogflowV2AnnotatedMessagePart[]; + } /** * Represents the contents of the original request that was passed to the `[Streaming]DetectIntent` call. */ @@ -1847,30 +2593,30 @@ export namespace dialogflow_v2 { /** * Optional. This field is set to the value of the `QueryParameters.payload` field passed in the request. Some integrations that query a Dialogflow agent may provide additional information in the payload. In particular for the Telephony Gateway this field has the form: <pre>{ "telephony": { "caller_id": "+18558363987" } }</pre> Note: The caller ID field (`caller_id`) will be redacted for Standard Edition agents and populated with the caller ID in [E.164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. */ - payload?: {[key: string]: any}; + payload?: {[key: string]: any} | null; /** * The source of this request, e.g., `google`, `facebook`, `slack`. It is set by Dialogflow-owned servers. */ - source?: string; + source?: string | null; /** * Optional. The version of the protocol used for this request. This field is AoG-specific. */ - version?: string; + version?: string | null; } /** - * Instructs the speech synthesizer on how to generate the output audio content. + * Instructs the speech synthesizer on how to generate the output audio content. If this audio config is supplied in a request, it overrides all existing text-to-speech settings applied to the agent. */ export interface Schema$GoogleCloudDialogflowV2OutputAudioConfig { /** * Required. Audio encoding of the synthesized audio content. */ - audioEncoding?: string; + audioEncoding?: string | null; /** - * Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). + * The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. If this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality). */ - sampleRateHertz?: number; + sampleRateHertz?: number | null; /** - * Optional. Configuration of how speech should be synthesized. + * Configuration of how speech should be synthesized. */ synthesizeSpeechConfig?: Schema$GoogleCloudDialogflowV2SynthesizeSpeechConfig; } @@ -1896,33 +2642,33 @@ export namespace dialogflow_v2 { */ export interface Schema$GoogleCloudDialogflowV2QueryParameters { /** - * Optional. The collection of contexts to be activated before this query is executed. + * The collection of contexts to be activated before this query is executed. */ contexts?: Schema$GoogleCloudDialogflowV2Context[]; /** - * Optional. The geo location of this conversational query. + * The geo location of this conversational query. */ geoLocation?: Schema$GoogleTypeLatLng; /** - * Optional. This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. + * This field can be used to pass custom data into the webhook associated with the agent. Arbitrary JSON objects are supported. */ - payload?: {[key: string]: any}; + payload?: {[key: string]: any} | null; /** - * Optional. Specifies whether to delete all contexts in the current session before the new ones are activated. + * Specifies whether to delete all contexts in the current session before the new ones are activated. */ - resetContexts?: boolean; + resetContexts?: boolean | null; /** - * Optional. Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. + * Configures the type of sentiment analysis to perform. If not provided, sentiment analysis is not performed. */ sentimentAnalysisRequestConfig?: Schema$GoogleCloudDialogflowV2SentimentAnalysisRequestConfig; /** - * Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. + * Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. */ sessionEntityTypes?: Schema$GoogleCloudDialogflowV2SessionEntityType[]; /** - * Optional. The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used. + * The time zone of this conversational query from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not provided, the time zone specified in agent settings is used. */ - timeZone?: string; + timeZone?: string | null; } /** * Represents the result of conversational query or event processing. @@ -1931,15 +2677,15 @@ export namespace dialogflow_v2 { /** * The action name from the matched intent. */ - action?: string; + action?: string | null; /** - * This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. + * This field is set to: - `false` if the matched intent has required parameters and not all of the required parameter values have been collected. - `true` if all required parameter values have been collected, or if the matched intent doesn't contain any required parameters. */ - allRequiredParamsPresent?: boolean; + allRequiredParamsPresent?: boolean | null; /** - * The free-form diagnostic info. For example, this field could contain webhook call latency. The string keys of the Struct's fields map can change without notice. + * Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain: - webhook call latency - webhook errors */ - diagnosticInfo?: {[key: string]: any}; + diagnosticInfo?: {[key: string]: any} | null; /** * The collection of rich messages to present to the user. */ @@ -1947,19 +2693,19 @@ export namespace dialogflow_v2 { /** * The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, `fulfillment_messages` should be preferred. */ - fulfillmentText?: string; + fulfillmentText?: string | null; /** - * The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name` and `webhook_state`. + * The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: `name`, `display_name`, `end_interaction` and `is_fallback`. */ intent?: Schema$GoogleCloudDialogflowV2Intent; /** - * The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. + * The intent detection confidence. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation. If there are `multiple knowledge_answers` messages, this value is set to the greatest `knowledgeAnswers.match_confidence` value in the list. */ - intentDetectionConfidence?: number; + intentDetectionConfidence?: number | null; /** - * The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. + * The language that was triggered during intent detection. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. */ - languageCode?: string; + languageCode?: string | null; /** * The collection of output contexts. If applicable, `output_contexts.parameters` contains entries with name `<parameter name>.original` containing the original parameter values before the query. */ @@ -1967,11 +2713,11 @@ export namespace dialogflow_v2 { /** * The collection of extracted parameters. */ - parameters?: {[key: string]: any}; + parameters?: {[key: string]: any} | null; /** - * The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If an event was provided as input, `query_text` is not set. + * The original conversational query text: - If natural language text was provided as input, `query_text` contains a copy of the input. - If natural language speech audio was provided as input, `query_text` contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked. - If automatic spell correction is enabled, `query_text` will contain the corrected user input. */ - queryText?: string; + queryText?: string | null; /** * The sentiment analysis result, which depends on the `sentiment_analysis_request_config` specified in the request. */ @@ -1979,28 +2725,28 @@ export namespace dialogflow_v2 { /** * The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set. This field is not guaranteed to be accurate or set. In particular this field isn't set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult. */ - speechRecognitionConfidence?: number; + speechRecognitionConfidence?: number | null; /** * If the query was fulfilled by a webhook call, this field is set to the value of the `payload` field returned in the webhook response. */ - webhookPayload?: {[key: string]: any}; + webhookPayload?: {[key: string]: any} | null; /** * If the query was fulfilled by a webhook call, this field is set to the value of the `source` field returned in the webhook response. */ - webhookSource?: string; + webhookSource?: string | null; } /** * The request message for Agents.RestoreAgent. */ export interface Schema$GoogleCloudDialogflowV2RestoreAgentRequest { /** - * The agent to restore. Example for how to restore an agent via the command line: <pre>curl \ 'https://dialogflow.googleapis.com/v2/projects/&lt;project_name&gt;/agent:restore\ -X POST \ -H 'Authorization: Bearer '$(gcloud auth application-default print-access-token) \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ --compressed \ --data-binary "{ 'agentContent': '$(cat &lt;agent zip file&gt; | base64 -w 0)' }"</pre> + * Zip compressed raw byte content for agent. */ - agentContent?: string; + agentContent?: string | null; /** * The URI to a Google Cloud Storage file containing the agent to restore. Note: The URI must start with "gs://". */ - agentUri?: string; + agentUri?: string | null; } /** * The response message for Agents.SearchAgents. @@ -2013,7 +2759,7 @@ export namespace dialogflow_v2 { /** * Token to retrieve the next page of results, or empty if there are no more results in the list. */ - nextPageToken?: string; + nextPageToken?: string | null; } /** * The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. @@ -2022,20 +2768,20 @@ export namespace dialogflow_v2 { /** * A non-negative number in the [0, +inf) range, which represents the absolute magnitude of sentiment, regardless of score (positive or negative). */ - magnitude?: number; + magnitude?: number | null; /** * Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). */ - score?: number; + score?: number | null; } /** * Configures the types of sentiment analysis to perform. */ export interface Schema$GoogleCloudDialogflowV2SentimentAnalysisRequestConfig { /** - * Optional. Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`. + * Instructs the service to perform sentiment analysis on `query_text`. If not provided, sentiment analysis is not performed on `query_text`. */ - analyzeQueryTextSentiment?: boolean; + analyzeQueryTextSentiment?: boolean | null; } /** * The result of sentiment analysis as configured by `sentiment_analysis_request_config`. @@ -2047,7 +2793,7 @@ export namespace dialogflow_v2 { queryTextSentiment?: Schema$GoogleCloudDialogflowV2Sentiment; } /** - * Represents a session entity type. Extends or replaces a developer entity type at the user session level (we refer to the entity types defined at the agent level as "developer entity types"). Note: session entity types apply to all queries, regardless of the language. + * Represents a session entity type. Extends or replaces a custom entity type at the user session level (we refer to the entity types defined at the agent level as "custom entity types"). Note: session entity types apply to all queries, regardless of the language. */ export interface Schema$GoogleCloudDialogflowV2SessionEntityType { /** @@ -2055,13 +2801,26 @@ export namespace dialogflow_v2 { */ entities?: Schema$GoogleCloudDialogflowV2EntityTypeEntity[]; /** - * Required. Indicates whether the additional data should override or supplement the developer entity type definition. + * Required. Indicates whether the additional data should override or supplement the custom entity type definition. */ - entityOverrideMode?: string; + entityOverrideMode?: string | null; /** * Required. The unique identifier of this session entity type. Format: `projects/<Project ID>/agent/sessions/<Session ID>/entityTypes/<Entity Type Display Name>`. `<Entity Type Display Name>` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. */ - name?: string; + name?: string | null; + } + /** + * Hints for the speech recognizer to help with recognition in a specific conversation state. + */ + export interface Schema$GoogleCloudDialogflowV2SpeechContext { + /** + * Optional. Boost for this context compared to other contexts: * If the boost is positive, Dialogflow will increase the probability that the phrases in this context are recognized over similar sounding phrases. * If the boost is unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow recommends that you use boosts in the range (0, 20] and that you find a value that fits your use case with binary search. + */ + boost?: number | null; + /** + * Optional. A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. This list can be used to: * improve accuracy for words and phrases you expect the user to say, e.g. typical commands for your Dialogflow agent * add additional words to the speech recognizer vocabulary * ... See the [Cloud Speech documentation](https://cloud.google.com/speech-to-text/quotas) for usage limits. + */ + phrases?: string[] | null; } /** * Configuration of how speech should be synthesized. @@ -2070,15 +2829,15 @@ export namespace dialogflow_v2 { /** * Optional. An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech. Effects are applied on top of each other in the order they are given. */ - effectsProfileId?: string[]; + effectsProfileId?: string[] | null; /** * Optional. Speaking pitch, in the range [-20.0, 20.0]. 20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch. */ - pitch?: number; + pitch?: number | null; /** * Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other values < 0.25 or > 4.0 will return an error. */ - speakingRate?: number; + speakingRate?: number | null; /** * Optional. The desired voice of the synthesized audio. */ @@ -2086,37 +2845,63 @@ export namespace dialogflow_v2 { /** * Optional. Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will play at approximately half the amplitude of the normal native signal amplitude. A value of +6.0 (dB) will play at approximately twice the amplitude of the normal native signal amplitude. We strongly recommend not to exceed +10 (dB) as there's usually no effective increase in loudness for any value greater than that. */ - volumeGainDb?: number; + volumeGainDb?: number | null; } /** * Represents the natural language text to be processed. */ export interface Schema$GoogleCloudDialogflowV2TextInput { /** - * Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. + * Required. The language of this conversational query. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */ - languageCode?: string; + languageCode?: string | null; /** * Required. The UTF-8 encoded natural language text to be processed. Text length must not exceed 256 characters. */ - text?: string; + text?: string | null; } /** * The request message for Agents.TrainAgent. */ export interface Schema$GoogleCloudDialogflowV2TrainAgentRequest {} + /** + * Represents a single validation error. + */ + export interface Schema$GoogleCloudDialogflowV2ValidationError { + /** + * The names of the entries that the error is associated with. Format: - "projects/<Project ID>/agent", if the error is associated with the entire agent. - "projects/<Project ID>/agent/intents/<Intent ID>", if the error is associated with certain intents. - "projects/<Project ID>/agent/intents/<Intent Id>/trainingPhrases/<Training Phrase ID>", if the error is associated with certain intent training phrases. - "projects/<Project ID>/agent/intents/<Intent Id>/parameters/<Parameter ID>", if the error is associated with certain intent parameters. - "projects/<Project ID>/agent/entities/<Entity ID>", if the error is associated with certain entities. + */ + entries?: string[] | null; + /** + * The detailed error messsage. + */ + errorMessage?: string | null; + /** + * The severity of the error. + */ + severity?: string | null; + } + /** + * Represents the output of agent validation. + */ + export interface Schema$GoogleCloudDialogflowV2ValidationResult { + /** + * Contains all validation errors. + */ + validationErrors?: Schema$GoogleCloudDialogflowV2ValidationError[]; + } /** * Description of which voice to use for speech synthesis. */ export interface Schema$GoogleCloudDialogflowV2VoiceSelectionParams { /** - * Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and gender. + * Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and ssml_gender. */ - name?: string; + name?: string | null; /** * Optional. The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement. If a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request. */ - ssmlGender?: string; + ssmlGender?: string | null; } /** * The request message for a webhook call. @@ -2133,18 +2918,18 @@ export namespace dialogflow_v2 { /** * The unique identifier of the response. Contains the same value as `[Streaming]DetectIntentResponse.response_id`. */ - responseId?: string; + responseId?: string | null; /** * The unique identifier of detectIntent request session. Can be used to identify end-user inside webhook implementation. Format: `projects/<Project ID>/agent/sessions/<Session ID>`, or `projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>`. */ - session?: string; + session?: string | null; } /** - * The response message for a webhook call. + * The response message for a webhook call. This response is validated by the Dialogflow server. If validation fails, an error will be returned in the QueryResult.diagnostic_info field. Setting JSON fields to an empty value with the wrong type is a common error. To avoid this error: - Use `""` for empty strings - Use `{}` or `null` for empty objects - Use `[]` or `null` for empty arrays For more information, see the [Protocol Buffers Language Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). */ export interface Schema$GoogleCloudDialogflowV2WebhookResponse { /** - * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. + * Optional. Makes the platform immediately invoke another `DetectIntent` call internally with the specified event as input. When this field is set, Dialogflow ignores the `fulfillment_text`, `fulfillment_messages`, and `payload` fields. */ followupEventInput?: Schema$GoogleCloudDialogflowV2EventInput; /** @@ -2154,7 +2939,7 @@ export namespace dialogflow_v2 { /** * Optional. The text to be shown on the screen. This value is passed directly to `QueryResult.fulfillment_text`. */ - fulfillmentText?: string; + fulfillmentText?: string | null; /** * Optional. The collection of output contexts. This value is passed directly to `QueryResult.output_contexts`. */ @@ -2162,11 +2947,28 @@ export namespace dialogflow_v2 { /** * Optional. This value is passed directly to `QueryResult.webhook_payload`. See the related `fulfillment_messages[i].payload field`, which may be used as an alternative to this field. This field can be used for Actions on Google responses. It should have a structure similar to the JSON message shown here. For more information, see [Actions on Google Webhook Format](https://developers.google.com/actions/dialogflow/webhook) <pre>{ "google": { "expectUserResponse": true, "richResponse": { "items": [ { "simpleResponse": { "textToSpeech": "this is a simple response" } } ] } } }</pre> */ - payload?: {[key: string]: any}; + payload?: {[key: string]: any} | null; + /** + * Optional. Additional session entity types to replace or extend developer entity types with. The entity synonyms apply to all languages and persist for the session of this query. Setting the session entity types inside webhook overwrites the session entity types that have been set through `DetectIntentRequest.query_params.session_entity_types`. + */ + sessionEntityTypes?: Schema$GoogleCloudDialogflowV2SessionEntityType[]; /** * Optional. This value is passed directly to `QueryResult.webhook_source`. */ - source?: string; + source?: string | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$GoogleLongrunningListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$GoogleLongrunningOperation[]; } /** * This resource represents a long-running operation that is the result of a network API call. @@ -2175,7 +2977,7 @@ export namespace dialogflow_v2 { /** * 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; + done?: boolean | null; /** * The error result of the operation in case of failure or cancellation. */ @@ -2183,36 +2985,36 @@ export namespace dialogflow_v2 { /** * 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}; + metadata?: {[key: string]: any} | null; /** * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */ - name?: string; + name?: string | null; /** * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ - response?: {[key: string]: any}; + response?: {[key: string]: any} | null; } /** * 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$GoogleProtobufEmpty {} /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */ export interface Schema$GoogleRpcStatus { /** * The status code, which should be an enum value of google.rpc.Code. */ - code?: number; + code?: number | null; /** * 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}>; + details?: Array<{[key: string]: any}> | null; /** * 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; + message?: string | null; } /** * An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges. @@ -2221,64 +3023,142 @@ export namespace dialogflow_v2 { /** * The latitude in degrees. It must be in the range [-90.0, +90.0]. */ - latitude?: number; + latitude?: number | null; /** * The longitude in degrees. It must be in the range [-180.0, +180.0]. */ - longitude?: number; + longitude?: number | null; } export class Resource$Projects { context: APIRequestContext; agent: Resource$Projects$Agent; + locations: Resource$Projects$Locations; operations: Resource$Projects$Operations; constructor(context: APIRequestContext) { this.context = context; this.agent = new Resource$Projects$Agent(this.context); + this.locations = new Resource$Projects$Locations(this.context); this.operations = new Resource$Projects$Operations(this.context); } /** - * dialogflow.projects.getAgent - * @desc Retrieves the specified agent. - * @alias dialogflow.projects.getAgent + * dialogflow.projects.deleteAgent + * @desc Deletes the specified agent. + * @alias dialogflow.projects.deleteAgent * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project that the agent to fetch is associated with. Format: `projects/`. + * @param {string} params.parent Required. The project that the agent to delete is associated with. Format: `projects/`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getAgent( - params?: Params$Resource$Projects$Getagent, + deleteAgent( + params?: Params$Resource$Projects$Deleteagent, options?: MethodOptions - ): GaxiosPromise; - getAgent( - params: Params$Resource$Projects$Getagent, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + deleteAgent( + params: Params$Resource$Projects$Deleteagent, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getAgent( - params: Params$Resource$Projects$Getagent, - callback: BodyResponseCallback + deleteAgent( + params: Params$Resource$Projects$Deleteagent, + callback: BodyResponseCallback ): void; - getAgent( - callback: BodyResponseCallback + deleteAgent( + callback: BodyResponseCallback ): void; - getAgent( + deleteAgent( paramsOrCallback?: - | Params$Resource$Projects$Getagent - | BodyResponseCallback, + | Params$Resource$Projects$Deleteagent + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getagent; + {}) as Params$Resource$Projects$Deleteagent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Deleteagent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/agent').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dialogflow.projects.getAgent + * @desc Retrieves the specified agent. + * @alias dialogflow.projects.getAgent + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project that the agent to fetch is associated with. Format: `projects/`. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getAgent( + params?: Params$Resource$Projects$Getagent, + options?: MethodOptions + ): GaxiosPromise; + getAgent( + params: Params$Resource$Projects$Getagent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getAgent( + params: Params$Resource$Projects$Getagent, + callback: BodyResponseCallback + ): void; + getAgent( + callback: BodyResponseCallback + ): void; + getAgent( + paramsOrCallback?: + | Params$Resource$Projects$Getagent + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getagent; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { @@ -2320,8 +3200,105 @@ export namespace dialogflow_v2 { ); } } + + /** + * dialogflow.projects.setAgent + * @desc Creates/updates the specified agent. + * @alias dialogflow.projects.setAgent + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project of this agent. Format: `projects/`. + * @param {string=} params.updateMask Optional. The mask to control which fields get updated. + * @param {().GoogleCloudDialogflowV2Agent} params.requestBody Request 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 + */ + setAgent( + params?: Params$Resource$Projects$Setagent, + options?: MethodOptions + ): GaxiosPromise; + setAgent( + params: Params$Resource$Projects$Setagent, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAgent( + params: Params$Resource$Projects$Setagent, + callback: BodyResponseCallback + ): void; + setAgent( + callback: BodyResponseCallback + ): void; + setAgent( + paramsOrCallback?: + | Params$Resource$Projects$Setagent + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Setagent; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Setagent; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/agent').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$Deleteagent + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The project that the agent to delete is associated with. Format: `projects/`. + */ + parent?: string; + } export interface Params$Resource$Projects$Getagent extends StandardParameters { /** @@ -2334,6 +3311,27 @@ export namespace dialogflow_v2 { */ parent?: string; } + export interface Params$Resource$Projects$Setagent + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The project of this agent. Format: `projects/`. + */ + parent?: string; + /** + * Optional. The mask to control which fields get updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2Agent; + } export class Resource$Projects$Agent { context: APIRequestContext; @@ -2355,7 +3353,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The project that the agent to export is associated with. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2ExportAgentRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2ExportAgentRequest} params.requestBody Request 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 @@ -2430,52 +3428,51 @@ export namespace dialogflow_v2 { } /** - * dialogflow.projects.agent.import - * @desc Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. Operation - * @alias dialogflow.projects.agent.import + * dialogflow.projects.agent.getFulfillment + * @desc Retrieves the fulfillment. + * @alias dialogflow.projects.agent.getFulfillment * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project that the agent to import is associated with. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2ImportAgentRequest} params.resource Request body data + * @param {string} params.name Required. The name of the fulfillment. Format: `projects//agent/fulfillment`. * @param {object} [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$Agent$Import, + getFulfillment( + params?: Params$Resource$Projects$Agent$Getfulfillment, options?: MethodOptions - ): GaxiosPromise; - import( - params: Params$Resource$Projects$Agent$Import, + ): GaxiosPromise; + getFulfillment( + params: Params$Resource$Projects$Agent$Getfulfillment, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - import( - params: Params$Resource$Projects$Agent$Import, - callback: BodyResponseCallback + getFulfillment( + params: Params$Resource$Projects$Agent$Getfulfillment, + callback: BodyResponseCallback ): void; - import( - callback: BodyResponseCallback + getFulfillment( + callback: BodyResponseCallback ): void; - import( + getFulfillment( paramsOrCallback?: - | Params$Resource$Projects$Agent$Import - | BodyResponseCallback, + | Params$Resource$Projects$Agent$Getfulfillment + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Agent$Import; + {}) as Params$Resource$Projects$Agent$Getfulfillment; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Agent$Import; + params = {} as Params$Resource$Projects$Agent$Getfulfillment; options = {}; } @@ -2488,76 +3485,83 @@ export namespace dialogflow_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/agent:import').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * dialogflow.projects.agent.restore - * @desc Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. Operation - * @alias dialogflow.projects.agent.restore + * dialogflow.projects.agent.getValidationResult + * @desc Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed. + * @alias dialogflow.projects.agent.getValidationResult * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project that the agent to restore is associated with. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2RestoreAgentRequest} params.resource Request body data + * @param {string=} params.languageCode Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string} params.parent Required. The project that the agent is associated with. Format: `projects/`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - restore( - params?: Params$Resource$Projects$Agent$Restore, + getValidationResult( + params?: Params$Resource$Projects$Agent$Getvalidationresult, options?: MethodOptions - ): GaxiosPromise; - restore( - params: Params$Resource$Projects$Agent$Restore, + ): GaxiosPromise; + getValidationResult( + params: Params$Resource$Projects$Agent$Getvalidationresult, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ValidationResult + > ): void; - restore( - params: Params$Resource$Projects$Agent$Restore, - callback: BodyResponseCallback + getValidationResult( + params: Params$Resource$Projects$Agent$Getvalidationresult, + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ValidationResult + > ): void; - restore( - callback: BodyResponseCallback + getValidationResult( + callback: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ValidationResult + > ): void; - restore( + getValidationResult( paramsOrCallback?: - | Params$Resource$Projects$Agent$Restore - | BodyResponseCallback, + | Params$Resource$Projects$Agent$Getvalidationresult + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleCloudDialogflowV2ValidationResult + > + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Agent$Restore; + {}) as Params$Resource$Projects$Agent$Getvalidationresult; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Agent$Restore; + params = {} as Params$Resource$Projects$Agent$Getvalidationresult; options = {}; } @@ -2570,11 +3574,11 @@ export namespace dialogflow_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/agent:restore').replace( + url: (rootUrl + '/v2/{+parent}/agent/validationResult').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), @@ -2584,24 +3588,190 @@ export namespace dialogflow_v2 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * dialogflow.projects.agent.search - * @desc Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections). - * @alias dialogflow.projects.agent.search - * @memberOf! () + * dialogflow.projects.agent.import + * @desc Imports the specified agent from a ZIP file. Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. Operation + * @alias dialogflow.projects.agent.import + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project that the agent to import is associated with. Format: `projects/`. + * @param {().GoogleCloudDialogflowV2ImportAgentRequest} params.requestBody Request 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$Agent$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Agent$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Agent$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Agent$Import + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Agent$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Agent$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/agent:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dialogflow.projects.agent.restore + * @desc Restores the specified agent from a ZIP file. Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. Operation + * @alias dialogflow.projects.agent.restore + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project that the agent to restore is associated with. Format: `projects/`. + * @param {().GoogleCloudDialogflowV2RestoreAgentRequest} params.requestBody Request 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 + */ + restore( + params?: Params$Resource$Projects$Agent$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Agent$Restore, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Agent$Restore, + callback: BodyResponseCallback + ): void; + restore( + callback: BodyResponseCallback + ): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Agent$Restore + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Agent$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Agent$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/agent:restore').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dialogflow.projects.agent.search + * @desc Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to [List Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections). + * @alias dialogflow.projects.agent.search + * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. - * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. + * @param {string=} params.pageToken The next_page_token value returned from a previous list request. * @param {string} params.parent Required. The project to list agents from. Format: `projects/`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2702,7 +3872,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The project that the agent to train is associated with. Format: `projects/`. - * @param {().GoogleCloudDialogflowV2TrainAgentRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2TrainAgentRequest} params.requestBody Request 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 @@ -2775,6 +3945,88 @@ export namespace dialogflow_v2 { return createAPIRequest(parameters); } } + + /** + * dialogflow.projects.agent.updateFulfillment + * @desc Updates the fulfillment. + * @alias dialogflow.projects.agent.updateFulfillment + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. + * @param {string=} params.updateMask Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. + * @param {().GoogleCloudDialogflowV2Fulfillment} params.requestBody Request 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 + */ + updateFulfillment( + params?: Params$Resource$Projects$Agent$Updatefulfillment, + options?: MethodOptions + ): GaxiosPromise; + updateFulfillment( + params: Params$Resource$Projects$Agent$Updatefulfillment, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateFulfillment( + params: Params$Resource$Projects$Agent$Updatefulfillment, + callback: BodyResponseCallback + ): void; + updateFulfillment( + callback: BodyResponseCallback + ): void; + updateFulfillment( + paramsOrCallback?: + | Params$Resource$Projects$Agent$Updatefulfillment + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Agent$Updatefulfillment; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Agent$Updatefulfillment; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Agent$Export @@ -2794,6 +4046,34 @@ export namespace dialogflow_v2 { */ requestBody?: Schema$GoogleCloudDialogflowV2ExportAgentRequest; } + export interface Params$Resource$Projects$Agent$Getfulfillment + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the fulfillment. Format: `projects//agent/fulfillment`. + */ + name?: string; + } + export interface Params$Resource$Projects$Agent$Getvalidationresult + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The language for which you want a validation result. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + */ + languageCode?: string; + /** + * Required. The project that the agent is associated with. Format: `projects/`. + */ + parent?: string; + } export interface Params$Resource$Projects$Agent$Import extends StandardParameters { /** @@ -2840,7 +4120,7 @@ export namespace dialogflow_v2 { */ pageSize?: number; /** - * Optional. The next_page_token value returned from a previous list request. + * The next_page_token value returned from a previous list request. */ pageToken?: string; /** @@ -2865,13 +4145,34 @@ export namespace dialogflow_v2 { */ requestBody?: Schema$GoogleCloudDialogflowV2TrainAgentRequest; } + export interface Params$Resource$Projects$Agent$Updatefulfillment + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - export class Resource$Projects$Agent$Entitytypes { - context: APIRequestContext; - entities: Resource$Projects$Agent$Entitytypes$Entities; - constructor(context: APIRequestContext) { - this.context = context; - this.entities = new Resource$Projects$Agent$Entitytypes$Entities( + /** + * Required. The unique identifier of the fulfillment. Format: `projects//agent/fulfillment`. + */ + name?: string; + /** + * Required. The mask to control which fields get updated. If the mask is not present, all fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowV2Fulfillment; + } + + export class Resource$Projects$Agent$Entitytypes { + context: APIRequestContext; + entities: Resource$Projects$Agent$Entitytypes$Entities; + constructor(context: APIRequestContext) { + this.context = context; + this.entities = new Resource$Projects$Agent$Entitytypes$Entities( this.context ); } @@ -2884,7 +4185,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The name of the agent to delete all entities types for. Format: `projects//agent`. - * @param {().GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest} params.requestBody Request 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 @@ -2966,7 +4267,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The name of the agent to update or create entity types in. Format: `projects//agent`. - * @param {().GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest} params.requestBody Request 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 @@ -3047,9 +4348,9 @@ export namespace dialogflow_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.languageCode Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string=} params.languageCode Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. * @param {string} params.parent Required. The agent to create a entity type for. Format: `projects//agent`. - * @param {().GoogleCloudDialogflowV2EntityType} params.resource Request body data + * @param {().GoogleCloudDialogflowV2EntityType} params.requestBody Request 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 @@ -3203,7 +4504,7 @@ export namespace dialogflow_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.languageCode Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string=} params.languageCode Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. * @param {string} params.name Required. The name of the entity type. Format: `projects//agent/entityTypes/`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3284,7 +4585,7 @@ export namespace dialogflow_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.languageCode Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string=} params.languageCode Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. * @param {string} params.parent Required. The agent to list all entity types from. Format: `projects//agent`. @@ -3386,10 +4687,10 @@ export namespace dialogflow_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.languageCode Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string=} params.languageCode Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. * @param {string} params.name The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: `projects//agent/entityTypes/`. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. - * @param {().GoogleCloudDialogflowV2EntityType} params.resource Request body data + * @param {().GoogleCloudDialogflowV2EntityType} params.requestBody Request 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 @@ -3505,7 +4806,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -3538,7 +4839,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language to retrieve entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -3554,7 +4855,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language to list entity synonyms for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -3578,7 +4879,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of entity synonyms defined in `entity_type`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -3610,7 +4911,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The name of the entity type to create entities in. Format: `projects//agent/entityTypes/`. - * @param {().GoogleCloudDialogflowV2BatchCreateEntitiesRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2BatchCreateEntitiesRequest} params.requestBody Request 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 @@ -3686,13 +4987,13 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.entityTypes.entities.batchDelete - * @desc Deletes entities in the specified entity type. Operation + * @desc Deletes entities in the specified entity type. Operation * @alias dialogflow.projects.agent.entityTypes.entities.batchDelete * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Required. The name of the entity type to delete entries for. Format: `projects//agent/entityTypes/`. - * @param {().GoogleCloudDialogflowV2BatchDeleteEntitiesRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2BatchDeleteEntitiesRequest} params.requestBody Request 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 @@ -3768,13 +5069,13 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.entityTypes.entities.batchUpdate - * @desc Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation + * @desc Updates or creates multiple entities in the specified entity type. This method does not affect entities in the entity type that aren't explicitly specified in the request. Operation * @alias dialogflow.projects.agent.entityTypes.entities.batchUpdate * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Required. The name of the entity type to update or create entities in. Format: `projects//agent/entityTypes/`. - * @param {().GoogleCloudDialogflowV2BatchUpdateEntitiesRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2BatchUpdateEntitiesRequest} params.requestBody Request 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 @@ -3915,7 +5216,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The name of the agent to delete all entities types for. Format: `projects//agent`. - * @param {().GoogleCloudDialogflowV2BatchDeleteIntentsRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2BatchDeleteIntentsRequest} params.requestBody Request 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 @@ -3997,7 +5298,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The name of the agent to update or create intents in. Format: `projects//agent`. - * @param {().GoogleCloudDialogflowV2BatchUpdateIntentsRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2BatchUpdateIntentsRequest} params.requestBody Request 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 @@ -4079,9 +5380,9 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string=} params.intentView Optional. The resource view to apply to the returned intent. - * @param {string=} params.languageCode Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string=} params.languageCode Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. * @param {string} params.parent Required. The agent to create a intent for. Format: `projects//agent`. - * @param {().GoogleCloudDialogflowV2Intent} params.resource Request body data + * @param {().GoogleCloudDialogflowV2Intent} params.requestBody Request 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 @@ -4236,7 +5537,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string=} params.intentView Optional. The resource view to apply to the returned intent. - * @param {string=} params.languageCode Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string=} params.languageCode Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. * @param {string} params.name Required. The name of the intent. Format: `projects//agent/intents/`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4318,7 +5619,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string=} params.intentView Optional. The resource view to apply to the returned intent. - * @param {string=} params.languageCode Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string=} params.languageCode Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. * @param {integer=} params.pageSize Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous list request. * @param {string} params.parent Required. The agent to list all intents from. Format: `projects//agent`. @@ -4419,10 +5720,10 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string=} params.intentView Optional. The resource view to apply to the returned intent. - * @param {string=} params.languageCode Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * @param {string=} params.languageCode Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. * @param {string} params.name The unique identifier of this intent. Required for Intents.UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/intents/`. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. - * @param {().GoogleCloudDialogflowV2Intent} params.resource Request body data + * @param {().GoogleCloudDialogflowV2Intent} params.requestBody Request 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 @@ -4542,7 +5843,7 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -4579,7 +5880,7 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language to retrieve training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -4599,7 +5900,7 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language to list training phrases, parameters and rich messages for. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -4627,7 +5928,7 @@ export namespace dialogflow_v2 { */ intentView?: string; /** - * Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow-enterprise/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. + * Optional. The language of training phrases, parameters and rich messages defined in `intent`. If not specified, the agent's default language is used. [Many languages](https://cloud.google.com/dialogflow/docs/reference/language) are supported. Note: languages must be enabled in the agent before they can be used. */ languageCode?: string; /** @@ -4743,7 +6044,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.session Required. The name of the session this query is sent to. Format: `projects//agent/sessions/`. It's up to the API caller to choose an appropriate session ID. It can be a random number or some type of user identifier (preferably hashed). The length of the session ID must not exceed 36 bytes. - * @param {().GoogleCloudDialogflowV2DetectIntentRequest} params.resource Request body data + * @param {().GoogleCloudDialogflowV2DetectIntentRequest} params.requestBody Request 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 @@ -4880,7 +6181,7 @@ export namespace dialogflow_v2 { * * @param {object} params Parameters for request * @param {string} params.parent Required. The session to create a context for. Format: `projects//agent/sessions/`. - * @param {().GoogleCloudDialogflowV2Context} params.resource Request body data + * @param {().GoogleCloudDialogflowV2Context} params.requestBody Request 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 @@ -5215,9 +6516,9 @@ export namespace dialogflow_v2 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. + * @param {string} params.name Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` * @param {string=} params.updateMask Optional. The mask to control which fields get updated. - * @param {().GoogleCloudDialogflowV2Context} params.resource Request body data + * @param {().GoogleCloudDialogflowV2Context} params.requestBody Request 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 @@ -5360,7 +6661,7 @@ export namespace dialogflow_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. + * Required. The unique identifier of the context. Format: `projects//agent/sessions//contexts/`. The `Context ID` is always converted to lowercase, may only contain characters in [a-zA-Z0-9_-%] and may be at most 250 bytes long. The following context names are reserved for internal use by Dialogflow. You should not use these contexts or create contexts with these names: * `__system_counters__` * `*_id_dialog_context` * `*_dialog_params_size` */ name?: string; /** @@ -5382,13 +6683,13 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.entityTypes.create - * @desc Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. + * @desc Creates a session entity type. If the specified session entity type already exists, overrides the session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. * @alias dialogflow.projects.agent.sessions.entityTypes.create * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.parent Required. The session to create a session entity type for. Format: `projects//agent/sessions/`. - * @param {().GoogleCloudDialogflowV2SessionEntityType} params.resource Request body data + * @param {().GoogleCloudDialogflowV2SessionEntityType} params.requestBody Request 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 @@ -5474,7 +6775,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.entityTypes.delete - * @desc Deletes the specified session entity type. + * @desc Deletes the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. * @alias dialogflow.projects.agent.sessions.entityTypes.delete * @memberOf! () * @@ -5545,7 +6846,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.entityTypes.get - * @desc Retrieves the specified session entity type. + * @desc Retrieves the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. * @alias dialogflow.projects.agent.sessions.entityTypes.get * @memberOf! () * @@ -5633,7 +6934,7 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.entityTypes.list - * @desc Returns the list of all session entity types in the specified session. + * @desc Returns the list of all session entity types in the specified session. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. * @alias dialogflow.projects.agent.sessions.entityTypes.list * @memberOf! () * @@ -5735,14 +7036,14 @@ export namespace dialogflow_v2 { /** * dialogflow.projects.agent.sessions.entityTypes.patch - * @desc Updates the specified session entity type. + * @desc Updates the specified session entity type. This method doesn't work with Google Assistant integration. Contact Dialogflow support if you need to use session entities with Google Assistant integration. * @alias dialogflow.projects.agent.sessions.entityTypes.patch * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Required. The unique identifier of this session entity type. Format: `projects//agent/sessions//entityTypes/`. `` must be the display name of an existing entity type in the same agent that will be overridden or supplemented. * @param {string=} params.updateMask Optional. The mask to control which fields get updated. - * @param {().GoogleCloudDialogflowV2SessionEntityType} params.resource Request body data + * @param {().GoogleCloudDialogflowV2SessionEntityType} params.requestBody Request 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 @@ -5907,12 +7208,393 @@ export namespace dialogflow_v2 { requestBody?: Schema$GoogleCloudDialogflowV2SessionEntityType; } + export class Resource$Projects$Locations { + context: APIRequestContext; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * dialogflow.projects.locations.operations.cancel + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @alias dialogflow.projects.locations.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dialogflow.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 dialogflow.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://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * dialogflow.projects.locations.operations.list + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @alias dialogflow.projects.locations.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleLongrunningListOperationsResponse + > + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback< + Schema$GoogleLongrunningListOperationsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$GoogleLongrunningListOperationsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleLongrunningListOperationsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/operations').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$Cancel + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export class Resource$Projects$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } + /** + * dialogflow.projects.operations.cancel + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @alias dialogflow.projects.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel( + params?: Params$Resource$Projects$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * dialogflow.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. @@ -5990,8 +7672,114 @@ export namespace dialogflow_v2 { return createAPIRequest(parameters); } } + + /** + * dialogflow.projects.operations.list + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @alias dialogflow.projects.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleLongrunningListOperationsResponse + > + ): void; + list( + params: Params$Resource$Projects$Operations$List, + callback: BodyResponseCallback< + Schema$GoogleLongrunningListOperationsResponse + > + ): void; + list( + callback: BodyResponseCallback< + Schema$GoogleLongrunningListOperationsResponse + > + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleLongrunningListOperationsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/operations').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$Cancel + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } export interface Params$Resource$Projects$Operations$Get extends StandardParameters { /** @@ -6004,4 +7792,28 @@ export namespace dialogflow_v2 { */ name?: string; } + export interface Params$Resource$Projects$Operations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } } diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index 546128db37..0905ed003c 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -226,7 +226,7 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2BigQueryKey { /** - * Absolute number of the row from the beginning of the table at the time of scanning. + * Row number inferred at the time the table was scanned. This value is nondeterministic, cannot be queried, and may be null for inspection jobs. To locate findings within a table, specify `inspect_job.storage_config.big_query_options.identifying_fields` in `CreateDlpJobRequest`. */ rowNumber?: string | null; /** @@ -243,7 +243,7 @@ export namespace dlp_v2 { */ excludedFields?: Schema$GooglePrivacyDlpV2FieldId[]; /** - * References to fields uniquely identifying rows within the table. Nested fields in the format, like `person.birthdate.year`, are allowed. + * Table fields that may uniquely identify a row within the table. When `actions.saveFindings.outputConfig.table` is specified, the values of columns specified here are available in the output table under `location.content_locations.record_location.record_key.id_values`. Nested fields such as `person.birthdate.year` are allowed. */ identifyingFields?: Schema$GooglePrivacyDlpV2FieldId[]; /** @@ -540,7 +540,7 @@ export namespace dlp_v2 { value?: string | null; } /** - * Findings container location data. + * Precise location of the finding within a document, record, image, or metadata container. */ export interface Schema$GooglePrivacyDlpV2ContentLocation { /** @@ -2195,7 +2195,7 @@ export namespace dlp_v2 { bigQueryKey?: Schema$GooglePrivacyDlpV2BigQueryKey; datastoreKey?: Schema$GooglePrivacyDlpV2DatastoreKey; /** - * Values of identifying columns in the given row. Order of values matches the order of field identifiers specified in the scanning request. + * Values of identifying columns in the given row. Order of values matches the order of `identifying_fields` specified in the scanning request. */ idValues?: string[] | null; } @@ -2448,15 +2448,15 @@ export namespace dlp_v2 { */ export interface Schema$GooglePrivacyDlpV2StorageConfig { /** - * BigQuery options specification. + * BigQuery options. */ bigQueryOptions?: Schema$GooglePrivacyDlpV2BigQueryOptions; /** - * Google Cloud Storage options specification. + * Google Cloud Storage options. */ cloudStorageOptions?: Schema$GooglePrivacyDlpV2CloudStorageOptions; /** - * Google Cloud Datastore options specification. + * Google Cloud Datastore options. */ datastoreOptions?: Schema$GooglePrivacyDlpV2DatastoreOptions; timespanConfig?: Schema$GooglePrivacyDlpV2TimespanConfig; diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index a8480e91ff..ca1f1f6290 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -266,9 +266,13 @@ export namespace docs_v1 { textStyle?: Schema$TextStyle; } /** - * Creates a Footer. The new footer is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned. + * Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned. */ export interface Schema$CreateFooterRequest { + /** + * The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style. + */ + sectionBreakLocation?: Schema$Location; /** * The type of footer to create. */ @@ -306,9 +310,13 @@ export namespace docs_v1 { footnoteId?: string | null; } /** - * Creates a Header. The new header is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned. + * Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specificed, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned. */ export interface Schema$CreateHeaderRequest { + /** + * The location of the SectionBreak which begins the section this header should belong to. If `section_break_location' is unset or if it refers to the first section break in the document body, the header applies to the DocumentStyle + */ + sectionBreakLocation?: Schema$Location; /** * The type of header to create. */ @@ -417,6 +425,24 @@ export namespace docs_v1 { */ range?: Schema$Range; } + /** + * Deletes a Footer from the document. + */ + export interface Schema$DeleteFooterRequest { + /** + * The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. + */ + footerId?: string | null; + } + /** + * Deletes a Header from the document. + */ + export interface Schema$DeleteHeaderRequest { + /** + * The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section. + */ + headerId?: string | null; + } /** * Deletes a NamedRange. */ @@ -621,11 +647,11 @@ export namespace docs_v1 { */ useCustomHeaderFooterMargins?: boolean | null; /** - * Indicates whether to use the even page header / footer IDs for the even pages. This property is read-only. + * Indicates whether to use the even page header / footer IDs for the even pages. */ useEvenPageHeaderFooter?: boolean | null; /** - * Indicates whether to use the first page header / footer IDs for the first page. This property is read-only. + * Indicates whether to use the first page header / footer IDs for the first page. */ useFirstPageHeaderFooter?: boolean | null; } @@ -665,6 +691,14 @@ export namespace docs_v1 { * Indicates if there was a suggested change to margin_bottom. */ marginBottomSuggested?: boolean | null; + /** + * Indicates if there was a suggested change to margin_footer. + */ + marginFooterSuggested?: boolean | null; + /** + * Indicates if there was a suggested change to margin_header. + */ + marginHeaderSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_left. */ @@ -685,6 +719,10 @@ export namespace docs_v1 { * A mask that indicates which of the fields in size have been changed in this suggestion. */ pageSizeSuggestionState?: Schema$SizeSuggestionState; + /** + * Indicates if there was a suggested change to use_custom_header_footer_margins. + */ + useCustomHeaderFooterMarginsSuggested?: boolean | null; /** * Indicates if there was a suggested change to use_even_page_header_footer. */ @@ -1988,6 +2026,14 @@ export namespace docs_v1 { * Deletes content from the document. */ deleteContentRange?: Schema$DeleteContentRangeRequest; + /** + * Deletes a footer from the document. + */ + deleteFooter?: Schema$DeleteFooterRequest; + /** + * Deletes a header from the document. + */ + deleteHeader?: Schema$DeleteHeaderRequest; /** * Deletes a named range. */ @@ -2161,7 +2207,7 @@ export namespace docs_v1 { */ paddingEnd?: Schema$Dimension; /** - * The width of the column. + * Output only. The width of the column. */ width?: Schema$Dimension; } @@ -2170,17 +2216,41 @@ export namespace docs_v1 { */ export interface Schema$SectionStyle { /** - * The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. + * The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than three columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. */ columnProperties?: Schema$SectionColumnProperties[]; /** - * The style of column separators. This style can be set even when there is one column in the section. + * The style of column separators. This style can be set even when there is one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ columnSeparatorStyle?: string | null; /** - * The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. + * The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ contentDirection?: string | null; + /** + * The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + */ + defaultFooterId?: string | null; + /** + * The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + */ + defaultHeaderId?: string | null; + /** + * The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + */ + evenPageFooterId?: string | null; + /** + * The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + */ + evenPageHeaderId?: string | null; + /** + * The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it is false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + */ + firstPageFooterId?: string | null; + /** + * The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it is false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + */ + firstPageHeaderId?: string | null; /** * The bottom page margin of the section. If unset, uses margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ @@ -2205,10 +2275,18 @@ export namespace docs_v1 { * The top page margin of the section. If unset, uses margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ marginTop?: Schema$Dimension; + /** + * The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + pageNumberStart?: number | null; /** * Output only. The type of section. */ sectionType?: string | null; + /** + * Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + useFirstPageHeaderFooter?: boolean | null; } /** * The shading of a paragraph. diff --git a/src/apis/doubleclickbidmanager/v1.1.ts b/src/apis/doubleclickbidmanager/v1.1.ts index ea1eaf57f6..cb7df71ac3 100644 --- a/src/apis/doubleclickbidmanager/v1.1.ts +++ b/src/apis/doubleclickbidmanager/v1.1.ts @@ -152,7 +152,7 @@ export namespace doubleclickbidmanager_v1_1 { */ filterType?: string | null; /** - * SDF Version (column names, types, order) in which the entities will be returned. Default to 3.1. + * SDF Version (column names, types, order) in which the entities will be returned. Default to 5. */ version?: string | null; } @@ -229,6 +229,15 @@ export namespace doubleclickbidmanager_v1_1 { */ reports?: Schema$Report[]; } + /** + * Additional query options. + */ + export interface Schema$Options { + /** + * Set to true and filter your report by `FILTER_INSERTION_ORDER` or `FILTER_LINE_ITEM` to include data for audience lists specifically targeted by those items. + */ + includeOnlyTargetedUserLists?: boolean | null; + } /** * Parameters of a query or report. */ @@ -249,6 +258,10 @@ export namespace doubleclickbidmanager_v1_1 { * Metrics to include as columns in your report. */ metrics?: string[] | null; + /** + * Additional query options. + */ + options?: Schema$Options; /** * Report type. */ @@ -360,6 +373,10 @@ export namespace doubleclickbidmanager_v1_1 { * Canonical timezone code for report generation time. Defaults to America/New_York. */ nextRunTimezoneCode?: string | null; + /** + * When to start running the query. Not applicable to `ONE_TIME` frequency. + */ + startTimeMs?: string | null; } /** * Represents a report. diff --git a/src/apis/doubleclickbidmanager/v1.ts b/src/apis/doubleclickbidmanager/v1.ts index 1cc98be373..584e6f359e 100644 --- a/src/apis/doubleclickbidmanager/v1.ts +++ b/src/apis/doubleclickbidmanager/v1.ts @@ -152,7 +152,7 @@ export namespace doubleclickbidmanager_v1 { */ filterType?: string | null; /** - * SDF Version (column names, types, order) in which the entities will be returned. Default to 3.1. + * SDF Version (column names, types, order) in which the entities will be returned. Default to 5. */ version?: string | null; } diff --git a/src/apis/drive/v2.ts b/src/apis/drive/v2.ts index 38821d8ae2..858e38d884 100644 --- a/src/apis/drive/v2.ts +++ b/src/apis/drive/v2.ts @@ -1440,9 +1440,6 @@ export namespace drive_v2 { * A revision of a file. */ export interface Schema$Revision { - /** - * Short term download URL for the file. This will only be populated on files with content stored in Drive. - */ downloadUrl?: string | null; /** * The ETag of the revision. diff --git a/src/apis/file/v1.ts b/src/apis/file/v1.ts index 190df72d0b..2f77fa37a2 100644 --- a/src/apis/file/v1.ts +++ b/src/apis/file/v1.ts @@ -137,7 +137,7 @@ export namespace file_v1 { name?: string | null; } /** - * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", }, "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } ``` + * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } ``` */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { /** @@ -244,7 +244,7 @@ export namespace file_v1 { nodeId?: string | null; } /** - * NotificationMetadata is the notification state for an instance. + * This message has been deprecated. NotificationMetadata is the notification state for an instance. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata { /** @@ -278,7 +278,7 @@ export namespace file_v1 { resourceUrl?: string | null; } /** - * RolloutMetadata for an actuation instance. It maps to a single RolloutType. + * This message has been deprecated. RolloutMetadata for an actuation instance. It maps to a single RolloutType. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata { /** @@ -333,7 +333,7 @@ export namespace file_v1 { */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata { /** - * Optional: user-defined instance eligibility. + * Optional. User-defined instance eligibility. */ eligibility?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility; /** @@ -341,7 +341,7 @@ export namespace file_v1 { */ exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; /** - * Optional: list of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch. + * Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch. */ nodes?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata[]; /** @@ -358,7 +358,7 @@ export namespace file_v1 { */ createTime?: string | null; /** - * Optional. A description of the instance (2048 characters or less). + * Optional. The description of the instance (2048 characters or less). */ description?: string | null; /** @@ -374,7 +374,7 @@ export namespace file_v1 { */ labels?: {[key: string]: string} | null; /** - * Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. + * Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}. */ name?: string | null; /** @@ -1080,7 +1080,7 @@ export namespace file_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. + * @param {string} params.name Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}. * @param {string=} params.updateMask Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields: * "description" * "file_shares" * "labels" * @param {().Instance} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1228,7 +1228,7 @@ export namespace file_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The resource name of the instance, in the format projects/{project_id}/locations/{location_id}/instances/{instance_id}. + * Output only. The resource name of the instance, in the format projects/{project}/locations/{location}/instances/{instance}. */ name?: string; /** diff --git a/src/apis/file/v1beta1.ts b/src/apis/file/v1beta1.ts index f677d7cf3b..bcc329874b 100644 --- a/src/apis/file/v1beta1.ts +++ b/src/apis/file/v1beta1.ts @@ -137,7 +137,7 @@ export namespace file_v1beta1 { name?: string | null; } /** - * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "rollout_metadata": { "projects/cloud-sql/locations/global/rolloutTypes/software_update": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-28-2018", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-28-2018-canary", }, "projects/cloud-sql/locations/global/rolloutTypes/instance_restart": { "release": "projects/cloud-sql/locations/global/releases/cloud-sql-09-20-repair", "rollout": "projects/cloud-sql/locations/us-east1/rollouts/cloud-sql-09-20-repair-100-percent", } } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } ``` + * Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project=snapchat, producer-project=cloud-sql: ```json Instance: { "name": "projects/snapchat/locations/us-east1/instances/prod-instance", "create_time": { "seconds": 1526406431, }, "labels": { "env": "prod", "foo": "bar" }, "state": READY, "software_versions": { "software_update": "cloud-sql-09-28-2018", }, "maintenance_policy_names": { "UpdatePolicy": "projects/snapchat/locations/us-east1/maintenancePolicies/prod-update-policy", } "tenant_project_id": "cloud-sql-test-tenant", "producer_metadata": { "cloud-sql-tier": "basic", "cloud-sql-instance-size": "1G", }, "provisioned_resources": [ { "resource-type": "compute-instance", "resource-url": "https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1", } ], "maintenance_schedules": { "csa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, }, "ncsa_rollout": { "start_time": { "seconds": 1526406431, }, "end_time": { "seconds": 1535406431, }, } }, "consumer_defined_name": "my-sql-instance1", } ``` */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1Instance { /** @@ -244,7 +244,7 @@ export namespace file_v1beta1 { nodeId?: string | null; } /** - * NotificationMetadata is the notification state for an instance. + * This message has been deprecated. NotificationMetadata is the notification state for an instance. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1NotificationMetadata { /** @@ -278,7 +278,7 @@ export namespace file_v1beta1 { resourceUrl?: string | null; } /** - * RolloutMetadata for an actuation instance. It maps to a single RolloutType. + * This message has been deprecated. RolloutMetadata for an actuation instance. It maps to a single RolloutType. */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1RolloutMetadata { /** @@ -333,7 +333,7 @@ export namespace file_v1beta1 { */ export interface Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloMetadata { /** - * Optional: user-defined instance eligibility. + * Optional. User-defined instance eligibility. */ eligibility?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloEligibility; /** @@ -341,7 +341,7 @@ export namespace file_v1beta1 { */ exclusions?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1SloExclusion[]; /** - * Optional: list of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch. + * Optional. List of nodes. Some producers need to use per-node metadata to calculate SLO. This field allows such producers to publish per-node SLO meta data, which will be consumed by SSA Eligibility Exporter and published in the form of per node metric to Monarch. */ nodes?: Schema$GoogleCloudSaasacceleratorManagementProvidersV1NodeSloMetadata[]; /** @@ -358,7 +358,7 @@ export namespace file_v1beta1 { */ createTime?: string | null; /** - * Optional. A description of the instance (2048 characters or less). + * Optional. The description of the instance (2048 characters or less). */ description?: string | null; /** diff --git a/src/apis/firebasehosting/v1beta1.ts b/src/apis/firebasehosting/v1beta1.ts index 3174d2a2de..81d1f0ce51 100644 --- a/src/apis/firebasehosting/v1beta1.ts +++ b/src/apis/firebasehosting/v1beta1.ts @@ -103,6 +103,7 @@ export namespace firebasehosting_v1beta1 { */ export class Firebasehosting { context: APIRequestContext; + projects: Resource$Projects; sites: Resource$Sites; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -111,6 +112,7 @@ export namespace firebasehosting_v1beta1 { google, }; + this.projects = new Resource$Projects(this.context); this.sites = new Resource$Sites(this.context); } } @@ -154,6 +156,27 @@ export namespace firebasehosting_v1beta1 { */ token?: string | null; } + /** + * The request sent to CloneVersion. + */ + export interface Schema$CloneVersionRequest { + /** + * If provided, only paths that do not match any of the regexes in this list will be included in the new version. + */ + exclude?: Schema$PathFilter; + /** + * If true, immediately finalize the version after cloning is complete. + */ + finalize?: boolean | null; + /** + * If provided, only paths that match one or more regexes in this list will be included in the new version. + */ + include?: Schema$PathFilter; + /** + * Required. The name of the version to be cloned, in the format: `sites/{site}/versions/{version}` + */ + sourceVersion?: string | null; + } /** * 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). */ @@ -307,6 +330,40 @@ export namespace firebasehosting_v1beta1 { */ versions?: Schema$Version[]; } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * 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} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * A representation of filter path. + */ + export interface Schema$PathFilter { + /** + * An array of regexes to filter by. + */ + regexes?: string[] | null; + } export interface Schema$PopulateVersionFilesRequest { /** * A set of file paths to the hashes corresponding to assets that should be added to the version. Note that a file path to an empty hash will remove the path from the version. Calculate a hash by Gzipping the file then taking the SHA256 hash of the newly compressed file. @@ -453,6 +510,23 @@ export namespace firebasehosting_v1beta1 { */ maxVersions?: string | null; } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * 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}> | null; + /** + * 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 | null; + } /** * A `Version` is the collection of configuration and [static files](sites.versions.files) that determine how a site is displayed. */ @@ -528,6 +602,107 @@ export namespace firebasehosting_v1beta1 { status?: string | null; } + export class Resource$Projects { + context: APIRequestContext; + operations: Resource$Projects$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Projects$Operations(this.context); + } + } + + export class Resource$Projects$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * firebasehosting.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 firebasehosting.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://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$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; + } + export class Resource$Sites { context: APIRequestContext; domains: Resource$Sites$Domains; @@ -1378,6 +1553,82 @@ export namespace firebasehosting_v1beta1 { this.files = new Resource$Sites$Versions$Files(this.context); } + /** + * firebasehosting.sites.versions.clone + * @desc Creates a new version on the target site using the content of the specified version. + * @alias firebasehosting.sites.versions.clone + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The target site where the cloned version will reside, in the format: `sites/{site}` + * @param {().CloneVersionRequest} params.requestBody Request 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 + */ + clone( + params?: Params$Resource$Sites$Versions$Clone, + options?: MethodOptions + ): GaxiosPromise; + clone( + params: Params$Resource$Sites$Versions$Clone, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + clone( + params: Params$Resource$Sites$Versions$Clone, + callback: BodyResponseCallback + ): void; + clone(callback: BodyResponseCallback): void; + clone( + paramsOrCallback?: + | Params$Resource$Sites$Versions$Clone + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sites$Versions$Clone; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sites$Versions$Clone; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://firebasehosting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/versions:clone').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + /** * firebasehosting.sites.versions.create * @desc Creates a new version for a site. @@ -1762,6 +2013,23 @@ export namespace firebasehosting_v1beta1 { } } + export interface Params$Resource$Sites$Versions$Clone + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The target site where the cloned version will reside, in the format: `sites/{site}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloneVersionRequest; + } export interface Params$Resource$Sites$Versions$Create extends StandardParameters { /** diff --git a/src/apis/firebaserules/v1.ts b/src/apis/firebaserules/v1.ts index d3d41d8a16..a979b0038f 100644 --- a/src/apis/firebaserules/v1.ts +++ b/src/apis/firebaserules/v1.ts @@ -349,6 +349,14 @@ export namespace firebaserules_v1 { * First column on the source line associated with the source fragment. */ column?: number | null; + /** + * Start position relative to the beginning of the file. + */ + currentOffset?: number | null; + /** + * End position relative to the beginning of the file. + */ + endOffset?: number | null; /** * Name of the `File`. */ diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 3fecca7c8b..70671322d2 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -1233,7 +1233,7 @@ export namespace firestore_v1 { */ delete?: string | null; /** - * 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. + * Applies a transformation to a document. */ transform?: Schema$DocumentTransform; /** diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index eeb4a617ed..33d2e3067b 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -1081,7 +1081,7 @@ export namespace firestore_v1beta1 { */ delete?: string | null; /** - * 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. + * Applies a transformation to a document. */ transform?: Schema$DocumentTransform; /** diff --git a/src/apis/fitness/v1.ts b/src/apis/fitness/v1.ts index 91f38c16fb..2cb49ee0c3 100644 --- a/src/apis/fitness/v1.ts +++ b/src/apis/fitness/v1.ts @@ -130,11 +130,11 @@ export namespace fitness_v1 { */ export interface Schema$AggregateBy { /** - * A data source ID to aggregate. Mutually exclusive of dataTypeName. Only data from the specified data source ID will be included in the aggregation. The dataset in the response will have the same data source ID. + * A data source ID to aggregate. Only data from the specified data source ID will be included in the aggregation. If specified, this data source must exist; the OAuth scopes in the supplied credentials must grant read access to this data type. The dataset in the response will have the same data source ID. Note: Data can be aggregated by either the dataTypeName or the dataSourceId, not both. */ dataSourceId?: string | null; /** - * The data type to aggregate. All data sources providing this data type will contribute data to the aggregation. The response will contain a single dataset for this data type name. The dataset will have a data source ID of derived:com.google.:com.google.android.gms:aggregated + * The data type to aggregate. All data sources providing this data type will contribute data to the aggregation. The response will contain a single dataset for this data type name. The dataset will have a data source ID of derived::com.google.android.gms:aggregated. If the user has no data for this data type, an empty data set will be returned. Note: Data can be aggregated by either the dataTypeName or the dataSourceId, not both. */ dataTypeName?: string | null; } @@ -305,7 +305,7 @@ export namespace fitness_v1 { */ dataQualityStandard?: string[] | null; /** - * A unique identifier for the data stream produced by this data source. The identifier includes: - The physical device's manufacturer, model, and serial number (UID). - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. - The data source's type. - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName 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 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 Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form. + * A unique identifier for the data stream produced by this data source. The identifier includes: - The physical device's manufacturer, model, and serial number (UID). - The application's package name or name. Package name is used when the data source was created by an Android application. The developer project number is used when the data source was created by a REST client. - The data source's type. - The data source's stream name. Note that not all attributes of the data source are used as part of the stream identifier. In particular, the version of the hardware/the application isn't used. This allows us to preserve the same stream through version updates. This also means that two DataSource objects may represent the same data stream even if they're not equal. The exact format of the data stream ID created by an Android application is: type:dataType.name:application.packageName:device.manufacturer:device.model:device.uid:dataStreamName 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 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 and device UID are obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the developer project number in clear and normal form. This means a client will see a different set of data_stream_ids than another client with different credentials. */ dataStreamId?: string | null; /** @@ -370,7 +370,7 @@ export namespace fitness_v1 { */ type?: string | null; /** - * The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form. + * The serial number or other unique ID for the hardware. This field is obfuscated when read by any REST or Android client that did not create the data source. Only the data source creator will see the uid field in clear and normal form. The obfuscation preserves equality; that is, given two IDs, if id1 == id2, obfuscated(id1) == obfuscated(id2). */ uid?: string | null; /** @@ -471,7 +471,7 @@ export namespace fitness_v1 { startTimeMillis?: string | null; } /** - * Holder object for the value of a single field in a data point. A field value has a particular format and is only ever set to one of an integer or a floating point value. LINT.IfChange + * Holder object for the value of a single field in a data point. A field value has a particular format and is only ever set to one of an integer or a floating point value. */ export interface Schema$Value { /** @@ -622,7 +622,7 @@ export namespace fitness_v1 { /** * fitness.users.dataSources.create - * @desc Creates a new data source that is unique across all data sources belonging to this user. The data stream ID field can be omitted and will be generated by the server with the correct format. The data stream ID is an ordered combination of some fields from the data source. In addition to the data source fields reflected into the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types. + * @desc Creates a new data source that is unique across all data sources belonging to this user. A data source is a unique source of sensor data. Data sources can expose raw data coming from hardware sensors on local or companion devices. They can also expose derived data, created by transforming or merging other data sources. Multiple data sources can exist for the same data type. Every data point in every dataset inserted into or read from the Fitness API has an associated data source. Each data source produces a unique stream of dataset updates, with a unique data source identifier. Not all changes to data source affect the data stream ID, so that data collected by updated versions of the same application/device can still be considered to belong to the same data source. Data sources are identified using a string generated by the server, based on the contents of the source being created. The dataStreamId field should not be set when invoking this method. It will be automatically generated by the server with the correct format. If a dataStreamId is set, it must match the format that the server would generate. This format is a combination of some fields from the data source, and has a specific order. If it doesn't match, the request will fail with an error. Specifying a DataType which is not a known type (beginning with "com.google.") will create a DataSource with a custom data type. Custom data types are only readable by the application that created them. Custom data types are deprecated; use standard data types instead. In addition to the data source fields included in the data source ID, the developer project number that is authenticated when creating the data source is included. This developer project number is obfuscated when read by any other developer reading public data types. * @alias fitness.users.dataSources.create * @memberOf! () * @@ -1608,6 +1608,7 @@ export namespace fitness_v1 { * @memberOf! () * * @param {object} params Parameters for request + * @param {integer=} params.activityType If non-empty, only sessions with these activity types should be returned. * @param {string=} params.endTime An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. * @param {boolean=} params.includeDeleted If true, deleted sessions will be returned. When set to true, sessions returned in this response will only have an ID and will not have any other fields. * @param {string=} params.pageToken The continuation token, which is used for incremental syncing. To get the next batch of changes, set this parameter to the value of nextPageToken from the previous response. This token is treated as a timestamp (in millis since epoch). If specified, the API returns sessions modified since this time. The page token is ignored if either start or end time is specified. If none of start time, end time, and the page token is specified, sessions modified in the last 30 days are returned. @@ -1783,6 +1784,10 @@ export namespace fitness_v1 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * If non-empty, only sessions with these activity types should be returned. + */ + activityType?: number[]; /** * An RFC3339 timestamp. Only sessions ending between the start and end times will be included in the response. */ diff --git a/src/apis/gamesConfiguration/package.json b/src/apis/gamesConfiguration/package.json deleted file mode 100644 index 530e8816cf..0000000000 --- a/src/apis/gamesConfiguration/package.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "name": "@google/gamesConfiguration", - "version": "0.1.0", - "description": "gamesConfiguration", - "main": "build/index.js", - "types": "build/index.d.ts", - "keywords": [ - "google" - ], - "author": "Google LLC", - "license": "Apache-2.0", - "homepage": "https://github.com/googleapis/google-api-nodejs-client", - "bugs": { - "url": "https://github.com/googleapis/google-api-nodejs-client/issues" - }, - "repository": { - "type": "git", - "url": "https://github.com/googleapis/google-api-nodejs-client.git" - }, - "engines": { - "node": ">=8.0.0" - }, - "scripts": { - "fix": "gts fix", - "lint": "gts check", - "compile": "tsc -p .", - "prepare": "npm run compile", - "docs": "typedoc --out docs/", - "webpack": "webpack" - }, - "dependencies": { - "googleapis-common": "^3.0.0" - }, - "devDependencies": { - "gts": "^1.0.0", - "null-loader": "^3.0.0", - "ts-loader": "^6.0.4", - "typedoc": "^0.16.0", - "typescript": "~3.7.0", - "webpack": "^4.35.3", - "webpack-cli": "^3.3.5" - } -} diff --git a/src/apis/gamesConfiguration/v1configuration.ts b/src/apis/gamesConfiguration/v1configuration.ts deleted file mode 100644 index f30a22bbb8..0000000000 --- a/src/apis/gamesConfiguration/v1configuration.ts +++ /dev/null @@ -1,1648 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace gamesConfiguration_v1configuration { - export interface Options extends GlobalOptions { - version: 'v1configuration'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * Google Play Game Services Publishing API - * - * The Publishing API for Google Play Game Services. - * - * @example - * const {google} = require('googleapis'); - * const gamesConfiguration = google.gamesConfiguration('v1configuration'); - * - * @namespace gamesConfiguration - * @type {Function} - * @version v1configuration - * @variation v1configuration - * @param {object=} options Options for Gamesconfiguration - */ - export class Gamesconfiguration { - context: APIRequestContext; - achievementConfigurations: Resource$Achievementconfigurations; - imageConfigurations: Resource$Imageconfigurations; - leaderboardConfigurations: Resource$Leaderboardconfigurations; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.achievementConfigurations = new Resource$Achievementconfigurations( - this.context - ); - this.imageConfigurations = new Resource$Imageconfigurations(this.context); - this.leaderboardConfigurations = new Resource$Leaderboardconfigurations( - this.context - ); - } - } - - /** - * This is a JSON template for an achievement configuration resource. - */ - export interface Schema$AchievementConfiguration { - /** - * The type of the achievement. Possible values are: - "STANDARD" - Achievement is either locked or unlocked. - "INCREMENTAL" - Achievement is incremental. - */ - achievementType?: string | null; - /** - * The draft data of the achievement. - */ - draft?: Schema$AchievementConfigurationDetail; - /** - * The ID of the achievement. - */ - id?: string | null; - /** - * The initial state of the achievement. Possible values are: - "HIDDEN" - Achievement is hidden. - "REVEALED" - Achievement is revealed. - "UNLOCKED" - Achievement is unlocked. - */ - initialState?: string | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfiguration. - */ - kind?: string | null; - /** - * The read-only published data of the achievement. - */ - published?: Schema$AchievementConfigurationDetail; - /** - * Steps to unlock. Only applicable to incremental achievements. - */ - stepsToUnlock?: number | null; - /** - * The token for this resource. - */ - token?: string | null; - } - /** - * This is a JSON template for an achievement configuration detail. - */ - export interface Schema$AchievementConfigurationDetail { - /** - * Localized strings for the achievement description. - */ - description?: Schema$LocalizedStringBundle; - /** - * The icon url of this achievement. Writes to this field are ignored. - */ - iconUrl?: string | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#achievementConfigurationDetail. - */ - kind?: string | null; - /** - * Localized strings for the achievement name. - */ - name?: Schema$LocalizedStringBundle; - /** - * Point value for the achievement. - */ - pointValue?: number | null; - /** - * The sort rank of this achievement. Writes to this field are ignored. - */ - sortRank?: number | null; - } - /** - * This is a JSON template for a ListConfigurations response. - */ - export interface Schema$AchievementConfigurationListResponse { - /** - * The achievement configurations. - */ - items?: Schema$AchievementConfiguration[]; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string games#achievementConfigurationListResponse. - */ - kind?: string | null; - /** - * The pagination token for the next page of results. - */ - nextPageToken?: string | null; - } - /** - * This is a JSON template for a number affix resource. - */ - export interface Schema$GamesNumberAffixConfiguration { - /** - * When the language requires special treatment of "small" numbers (as with 2, 3, and 4 in Czech; or numbers ending 2, 3, or 4 but not 12, 13, or 14 in Polish). - */ - few?: Schema$LocalizedStringBundle; - /** - * When the language requires special treatment of "large" numbers (as with numbers ending 11-99 in Maltese). - */ - many?: Schema$LocalizedStringBundle; - /** - * When the language requires special treatment of numbers like one (as with the number 1 in English and most other languages; in Russian, any number ending in 1 but not ending in 11 is in this class). - */ - one?: Schema$LocalizedStringBundle; - /** - * When the language does not require special treatment of the given quantity (as with all numbers in Chinese, or 42 in English). - */ - other?: Schema$LocalizedStringBundle; - /** - * When the language requires special treatment of numbers like two (as with 2 in Welsh, or 102 in Slovenian). - */ - two?: Schema$LocalizedStringBundle; - /** - * When the language requires special treatment of the number 0 (as in Arabic). - */ - zero?: Schema$LocalizedStringBundle; - } - /** - * This is a JSON template for a number format resource. - */ - export interface Schema$GamesNumberFormatConfiguration { - /** - * The curreny code string. Only used for CURRENCY format type. - */ - currencyCode?: string | null; - /** - * The formatting for the number. Possible values are: - "NUMERIC" - Numbers are formatted to have no digits or a fixed number of digits after the decimal point according to locale. An optional custom unit can be added. - "TIME_DURATION" - Numbers are formatted to hours, minutes and seconds. - "CURRENCY" - Numbers are formatted to currency according to locale. - */ - numberFormatType?: string | null; - /** - * The number of decimal places for number. Only used for NUMERIC format type. - */ - numDecimalPlaces?: number | null; - /** - * An optional suffix for the NUMERIC format type. These strings follow the same plural rules as all Android string resources. - */ - suffix?: Schema$GamesNumberAffixConfiguration; - } - /** - * This is a JSON template for an image configuration resource. - */ - export interface Schema$ImageConfiguration { - /** - * The image type for the image. - */ - imageType?: string | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#imageConfiguration. - */ - kind?: string | null; - /** - * The resource ID of resource which the image belongs to. - */ - resourceId?: string | null; - /** - * The url for this image. - */ - url?: string | null; - } - /** - * This is a JSON template for an leaderboard configuration resource. - */ - export interface Schema$LeaderboardConfiguration { - /** - * The draft data of the leaderboard. - */ - draft?: Schema$LeaderboardConfigurationDetail; - /** - * The ID of the leaderboard. - */ - id?: string | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfiguration. - */ - kind?: string | null; - /** - * The read-only published data of the leaderboard. - */ - published?: Schema$LeaderboardConfigurationDetail; - /** - * Maximum score that can be posted to this leaderboard. - */ - scoreMax?: string | null; - /** - * Minimum score that can be posted to this leaderboard. - */ - scoreMin?: string | null; - /** - * The type of the leaderboard. Possible values are: - "LARGER_IS_BETTER" - Larger scores posted are ranked higher. - "SMALLER_IS_BETTER" - Smaller scores posted are ranked higher. - */ - scoreOrder?: string | null; - /** - * The token for this resource. - */ - token?: string | null; - } - /** - * This is a JSON template for a leaderboard configuration detail. - */ - export interface Schema$LeaderboardConfigurationDetail { - /** - * The icon url of this leaderboard. Writes to this field are ignored. - */ - iconUrl?: string | null; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#leaderboardConfigurationDetail. - */ - kind?: string | null; - /** - * Localized strings for the leaderboard name. - */ - name?: Schema$LocalizedStringBundle; - /** - * The score formatting for the leaderboard. - */ - scoreFormat?: Schema$GamesNumberFormatConfiguration; - /** - * The sort rank of this leaderboard. Writes to this field are ignored. - */ - sortRank?: number | null; - } - /** - * This is a JSON template for a ListConfigurations response. - */ - export interface Schema$LeaderboardConfigurationListResponse { - /** - * The leaderboard configurations. - */ - items?: Schema$LeaderboardConfiguration[]; - /** - * Uniquely identifies the type of this resource. Value is always the fixed string games#leaderboardConfigurationListResponse. - */ - kind?: string | null; - /** - * The pagination token for the next page of results. - */ - nextPageToken?: string | null; - } - /** - * This is a JSON template for a localized string resource. - */ - export interface Schema$LocalizedString { - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedString. - */ - kind?: string | null; - /** - * The locale string. - */ - locale?: string | null; - /** - * The string value. - */ - value?: string | null; - } - /** - * This is a JSON template for a localized string bundle resource. - */ - export interface Schema$LocalizedStringBundle { - /** - * Uniquely identifies the type of this resource. Value is always the fixed string gamesConfiguration#localizedStringBundle. - */ - kind?: string | null; - /** - * The locale strings. - */ - translations?: Schema$LocalizedString[]; - } - - export class Resource$Achievementconfigurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * gamesConfiguration.achievementConfigurations.delete - * @desc Delete the achievement configuration with the given ID. - * @alias gamesConfiguration.achievementConfigurations.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.achievementId The ID of the achievement used by this method. - * @param {object} [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$Achievementconfigurations$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Achievementconfigurations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Achievementconfigurations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Achievementconfigurations$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Achievementconfigurations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Achievementconfigurations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1configuration/achievements/{achievementId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['achievementId'], - pathParams: ['achievementId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesConfiguration.achievementConfigurations.get - * @desc Retrieves the metadata of the achievement configuration with the given ID. - * @alias gamesConfiguration.achievementConfigurations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.achievementId The ID of the achievement used by this method. - * @param {object} [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$Achievementconfigurations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Achievementconfigurations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Achievementconfigurations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Achievementconfigurations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Achievementconfigurations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Achievementconfigurations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1configuration/achievements/{achievementId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['achievementId'], - pathParams: ['achievementId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesConfiguration.achievementConfigurations.insert - * @desc Insert a new achievement configuration in this application. - * @alias gamesConfiguration.achievementConfigurations.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.applicationId The application ID from the Google Play developer console. - * @param {().AchievementConfiguration} params.requestBody Request 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$Achievementconfigurations$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Achievementconfigurations$Insert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Achievementconfigurations$Insert, - callback: BodyResponseCallback - ): void; - insert( - callback: BodyResponseCallback - ): void; - insert( - paramsOrCallback?: - | Params$Resource$Achievementconfigurations$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Achievementconfigurations$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Achievementconfigurations$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1configuration/applications/{applicationId}/achievements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['applicationId'], - pathParams: ['applicationId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesConfiguration.achievementConfigurations.list - * @desc Returns a list of the achievement configurations in this application. - * @alias gamesConfiguration.achievementConfigurations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.applicationId The application ID from the Google Play developer console. - * @param {integer=} params.maxResults The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults. - * @param {string=} params.pageToken The token returned by the previous 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$Achievementconfigurations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Achievementconfigurations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$AchievementConfigurationListResponse - > - ): void; - list( - params: Params$Resource$Achievementconfigurations$List, - callback: BodyResponseCallback< - Schema$AchievementConfigurationListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$AchievementConfigurationListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Achievementconfigurations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$AchievementConfigurationListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Achievementconfigurations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Achievementconfigurations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1configuration/applications/{applicationId}/achievements' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['applicationId'], - pathParams: ['applicationId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * gamesConfiguration.achievementConfigurations.patch - * @desc Update the metadata of the achievement configuration with the given ID. This method supports patch semantics. - * @alias gamesConfiguration.achievementConfigurations.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.achievementId The ID of the achievement used by this method. - * @param {().AchievementConfiguration} params.requestBody Request 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$Achievementconfigurations$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Achievementconfigurations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Achievementconfigurations$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Achievementconfigurations$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Achievementconfigurations$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Achievementconfigurations$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1configuration/achievements/{achievementId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['achievementId'], - pathParams: ['achievementId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesConfiguration.achievementConfigurations.update - * @desc Update the metadata of the achievement configuration with the given ID. - * @alias gamesConfiguration.achievementConfigurations.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.achievementId The ID of the achievement used by this method. - * @param {().AchievementConfiguration} params.requestBody Request 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$Achievementconfigurations$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Achievementconfigurations$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Achievementconfigurations$Update, - callback: BodyResponseCallback - ): void; - update( - callback: BodyResponseCallback - ): void; - update( - paramsOrCallback?: - | Params$Resource$Achievementconfigurations$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Achievementconfigurations$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Achievementconfigurations$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1configuration/achievements/{achievementId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['achievementId'], - pathParams: ['achievementId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Achievementconfigurations$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the achievement used by this method. - */ - achievementId?: string; - } - export interface Params$Resource$Achievementconfigurations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the achievement used by this method. - */ - achievementId?: string; - } - export interface Params$Resource$Achievementconfigurations$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The application ID from the Google Play developer console. - */ - applicationId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AchievementConfiguration; - } - export interface Params$Resource$Achievementconfigurations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The application ID from the Google Play developer console. - */ - applicationId?: string; - /** - * The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults. - */ - maxResults?: number; - /** - * The token returned by the previous request. - */ - pageToken?: string; - } - export interface Params$Resource$Achievementconfigurations$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the achievement used by this method. - */ - achievementId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AchievementConfiguration; - } - export interface Params$Resource$Achievementconfigurations$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the achievement used by this method. - */ - achievementId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$AchievementConfiguration; - } - - export class Resource$Imageconfigurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * gamesConfiguration.imageConfigurations.upload - * @desc Uploads an image for a resource with the given ID and image type. - * @alias gamesConfiguration.imageConfigurations.upload - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.imageType Selects which image in a resource for this method. - * @param {string} params.resourceId The ID of the resource used by this method. - * @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 - */ - upload( - params?: Params$Resource$Imageconfigurations$Upload, - options?: MethodOptions - ): GaxiosPromise; - upload( - params: Params$Resource$Imageconfigurations$Upload, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - upload( - params: Params$Resource$Imageconfigurations$Upload, - callback: BodyResponseCallback - ): void; - upload(callback: BodyResponseCallback): void; - upload( - paramsOrCallback?: - | Params$Resource$Imageconfigurations$Upload - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Imageconfigurations$Upload; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Imageconfigurations$Upload; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1configuration/images/{resourceId}/imageType/{imageType}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - mediaUrl: ( - rootUrl + - '/upload/games/v1configuration/images/{resourceId}/imageType/{imageType}' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['resourceId', 'imageType'], - pathParams: ['imageType', 'resourceId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Imageconfigurations$Upload - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Selects which image in a resource for this method. - */ - imageType?: string; - /** - * The ID of the resource used by this method. - */ - resourceId?: string; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - - export class Resource$Leaderboardconfigurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * gamesConfiguration.leaderboardConfigurations.delete - * @desc Delete the leaderboard configuration with the given ID. - * @alias gamesConfiguration.leaderboardConfigurations.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.leaderboardId The ID of the leaderboard. - * @param {object} [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$Leaderboardconfigurations$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Leaderboardconfigurations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Leaderboardconfigurations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Leaderboardconfigurations$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Leaderboardconfigurations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Leaderboardconfigurations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1configuration/leaderboards/{leaderboardId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['leaderboardId'], - pathParams: ['leaderboardId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesConfiguration.leaderboardConfigurations.get - * @desc Retrieves the metadata of the leaderboard configuration with the given ID. - * @alias gamesConfiguration.leaderboardConfigurations.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.leaderboardId The ID of the leaderboard. - * @param {object} [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$Leaderboardconfigurations$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Leaderboardconfigurations$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Leaderboardconfigurations$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Leaderboardconfigurations$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Leaderboardconfigurations$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Leaderboardconfigurations$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1configuration/leaderboards/{leaderboardId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['leaderboardId'], - pathParams: ['leaderboardId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesConfiguration.leaderboardConfigurations.insert - * @desc Insert a new leaderboard configuration in this application. - * @alias gamesConfiguration.leaderboardConfigurations.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.applicationId The application ID from the Google Play developer console. - * @param {().LeaderboardConfiguration} params.requestBody Request 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$Leaderboardconfigurations$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Leaderboardconfigurations$Insert, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Leaderboardconfigurations$Insert, - callback: BodyResponseCallback - ): void; - insert( - callback: BodyResponseCallback - ): void; - insert( - paramsOrCallback?: - | Params$Resource$Leaderboardconfigurations$Insert - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Leaderboardconfigurations$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Leaderboardconfigurations$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1configuration/applications/{applicationId}/leaderboards' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['applicationId'], - pathParams: ['applicationId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesConfiguration.leaderboardConfigurations.list - * @desc Returns a list of the leaderboard configurations in this application. - * @alias gamesConfiguration.leaderboardConfigurations.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.applicationId The application ID from the Google Play developer console. - * @param {integer=} params.maxResults The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults. - * @param {string=} params.pageToken The token returned by the previous 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$Leaderboardconfigurations$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Leaderboardconfigurations$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$LeaderboardConfigurationListResponse - > - ): void; - list( - params: Params$Resource$Leaderboardconfigurations$List, - callback: BodyResponseCallback< - Schema$LeaderboardConfigurationListResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$LeaderboardConfigurationListResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Leaderboardconfigurations$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$LeaderboardConfigurationListResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Leaderboardconfigurations$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Leaderboardconfigurations$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/games/v1configuration/applications/{applicationId}/leaderboards' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['applicationId'], - pathParams: ['applicationId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * gamesConfiguration.leaderboardConfigurations.patch - * @desc Update the metadata of the leaderboard configuration with the given ID. This method supports patch semantics. - * @alias gamesConfiguration.leaderboardConfigurations.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.leaderboardId The ID of the leaderboard. - * @param {().LeaderboardConfiguration} params.requestBody Request 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$Leaderboardconfigurations$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Leaderboardconfigurations$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Leaderboardconfigurations$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Leaderboardconfigurations$Patch - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Leaderboardconfigurations$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Leaderboardconfigurations$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1configuration/leaderboards/{leaderboardId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['leaderboardId'], - pathParams: ['leaderboardId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * gamesConfiguration.leaderboardConfigurations.update - * @desc Update the metadata of the leaderboard configuration with the given ID. - * @alias gamesConfiguration.leaderboardConfigurations.update - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.leaderboardId The ID of the leaderboard. - * @param {().LeaderboardConfiguration} params.requestBody Request 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$Leaderboardconfigurations$Update, - options?: MethodOptions - ): GaxiosPromise; - update( - params: Params$Resource$Leaderboardconfigurations$Update, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - update( - params: Params$Resource$Leaderboardconfigurations$Update, - callback: BodyResponseCallback - ): void; - update( - callback: BodyResponseCallback - ): void; - update( - paramsOrCallback?: - | Params$Resource$Leaderboardconfigurations$Update - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Leaderboardconfigurations$Update; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Leaderboardconfigurations$Update; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/games/v1configuration/leaderboards/{leaderboardId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['leaderboardId'], - pathParams: ['leaderboardId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Leaderboardconfigurations$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the leaderboard. - */ - leaderboardId?: string; - } - export interface Params$Resource$Leaderboardconfigurations$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the leaderboard. - */ - leaderboardId?: string; - } - export interface Params$Resource$Leaderboardconfigurations$Insert - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The application ID from the Google Play developer console. - */ - applicationId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LeaderboardConfiguration; - } - export interface Params$Resource$Leaderboardconfigurations$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The application ID from the Google Play developer console. - */ - applicationId?: string; - /** - * The maximum number of resource configurations to return in the response, used for paging. For any response, the actual number of resources returned may be less than the specified maxResults. - */ - maxResults?: number; - /** - * The token returned by the previous request. - */ - pageToken?: string; - } - export interface Params$Resource$Leaderboardconfigurations$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the leaderboard. - */ - leaderboardId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LeaderboardConfiguration; - } - export interface Params$Resource$Leaderboardconfigurations$Update - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the leaderboard. - */ - leaderboardId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LeaderboardConfiguration; - } -} diff --git a/src/apis/gamesConfiguration/webpack.config.js b/src/apis/gamesConfiguration/webpack.config.js deleted file mode 100644 index 9e89e5b287..0000000000 --- a/src/apis/gamesConfiguration/webpack.config.js +++ /dev/null @@ -1,69 +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. - -// 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: 'Gamesconfiguration', - filename: 'gamesConfiguration.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/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index 1b46d31af7..2019a47cd0 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -237,7 +237,7 @@ export namespace healthcare_v1beta1 { */ config?: Schema$DeidentifyConfig; /** - * The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same project as the source dataset. De-identifying data across multiple projects is not supported. + * The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same project and location as the source dataset. De-identifying data across multiple projects or locations is not supported. */ destinationDataset?: string | null; } @@ -288,7 +288,7 @@ export namespace healthcare_v1beta1 { */ config?: Schema$DeidentifyConfig; /** - * The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same project. De-identifying data across multiple projects is not supported. * The destination FHIR store must not exist. * The caller must have the necessary permissions to create the destination FHIR store. + * The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same project. De-identifying data across multiple projects is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. */ destinationStore?: string | null; /** @@ -404,23 +404,23 @@ export namespace healthcare_v1beta1 { gcsDestination?: Schema$GoogleCloudHealthcareV1beta1FhirRestGcsDestination; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -429,7 +429,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$FhirConfig { /** - * Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions are removed in the output. + * Specifies FHIR paths to match and how to transform them. Any field that is not matched by a FieldMetadata is passed through to the output dataset unmodified. All extensions are removed in the output. If a field can be matched by more than one FieldMetadata, the first FieldMetadata.Action is applied. */ fieldMetadataList?: Schema$FieldMetadata[]; } @@ -484,7 +484,7 @@ export namespace healthcare_v1beta1 { */ action?: string | null; /** - * List of paths to FHIR fields to be redacted. Each path is a period-separated list where each component is either a field name or FHIR type name, for example: Patient, HumanName. For "choice" types (those defined in the FHIR spec with the form: field[x]) we use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. + * List of paths to FHIR fields to redact. Each path is a period-separated list where each component is either a field name or FHIR type name. All types begin with an upper case letter. For example, the resource field "Patient.Address.city", which uses a string type, can be matched by "Patient.Address.String". Path also supports partial matching. For example, "Patient.Address.city" can be matched by "Address.city" (Patient omitted). Partial matching and type matching can be combined, for example "Patient.Address.city" can be matched by "Address.String". For "choice" types (those defined in the FHIR spec with the form: field[x]), use two separate components. For example, "deceasedAge.unit" is matched by "Deceased.Age.unit". Supported types are: AdministrativeGenderCode, Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml. The sub-type for HumanName(for example HumanName.given, HumanName.family) can be omitted. */ paths?: string[] | null; } @@ -528,7 +528,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$GoogleCloudHealthcareV1beta1DicomGcsDestination { /** - * MIME types supported by DICOM spec. Each file is written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component exists 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 are used for output files: application/dicom -> .dcm image/jpeg -> .jpg image/png -> .png If unspecified, the instances are exported in their original DICOM format. + * MIME types supported by DICOM spec. Each file is written in the following format: `.../{study_id}/{series_id}/{instance_id}[/{frame_number}].{extension}` The frame_number component exists only for multi-frame instances. Refer to the DICOM conformance statement for permissible MIME types: https://cloud.google.com/healthcare/docs/dicom#retrieve_transaction The following extensions are used for output files: application/dicom -> .dcm image/jpeg -> .jpg image/png -> .png If unspecified, the instances are exported in their original DICOM format. */ mimeType?: string | null; /** @@ -668,6 +668,10 @@ export namespace healthcare_v1beta1 { * The configuration for the parser. It determines how the server parses the messages. */ parserConfig?: Schema$ParserConfig; + /** + * Determines whether duplicate messages should be rejected. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. + */ + rejectDuplicateMessage?: boolean | null; } /** * 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. @@ -743,7 +747,7 @@ export namespace healthcare_v1beta1 { */ dateShiftConfig?: Schema$DateShiftConfig; /** - * InfoTypes to apply this transformation to. If this is not specified, the transformation applies to any info_type. + * InfoTypes to apply this transformation to. If this is not specified, this transformation becomes the default transformation, and is used for any info_type that is not specified in another transformation. */ infoTypes?: string[] | null; /** @@ -847,7 +851,11 @@ export namespace healthcare_v1beta1 { */ export interface Schema$ListMessagesResponse { /** - * The returned message names. Won't be more values than the value of page_size in the request. + * The returned Messages. Won't be more Messages than the value of page_size in the request. See view for populated fields. + */ + hl7V2Messages?: Schema$Message[]; + /** + * Deprecated. Use `hl7_v2_messages` instead. The returned message names. Won't be more values than the value of page_size in the request. */ messages?: string[] | null; /** @@ -1091,7 +1099,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$SearchResourcesRequest { /** - * The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). + * The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). */ resourceType?: string | null; } @@ -3209,7 +3217,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.deidentify - * @desc Creates a new DICOM store containing de-identified data from the source store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error details field type is DeidentifyErrorDetails. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyDicomStoreSummary. If errors occur, error details field type is DeidentifyErrorDetails. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). * @alias healthcare.projects.locations.datasets.dicomStores.deidentify * @memberOf! () * @@ -5174,7 +5182,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.delete - * @desc DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @desc DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. * @example * * // BEFORE RUNNING: * // --------------- @@ -6027,7 +6035,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.delete - * @desc DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @desc DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. * @example * * // BEFORE RUNNING: * // --------------- @@ -6593,7 +6601,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete - * @desc DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the WADO-RS standard. + * @desc DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. * @example * * // BEFORE RUNNING: * // --------------- @@ -7570,7 +7578,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.deidentify - * @desc Creates a new FHIR store containing de-identified data from the source store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error details field type is DeidentifyErrorDetails. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). + * @desc De-identifies data from the source store and writes it to the destination store. The metadata field type is OperationMetadata. If the request is successful, the response field type is DeidentifyFhirStoreSummary. If errors occur, error details field type is DeidentifyErrorDetails. Errors are also logged to Stackdriver (see [Viewing logs](/healthcare/docs/how-tos/stackdriver-logging)). * @alias healthcare.projects.locations.datasets.fhirStores.deidentify * @memberOf! () * @@ -8967,7 +8975,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.capabilities - * @desc Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body will contain a JSON-encoded representation of a `CapabilityStatement` resource. + * @desc Gets the FHIR capability statement ([STU3](http://hl7.org/implement/standards/fhir/STU3/capabilitystatement.html), [R4](http://hl7.org/implement/standards/fhir/R4/capabilitystatement.html)), or the [conformance statement](http://hl7.org/implement/standards/fhir/DSTU2/conformance.html) in the DSTU2 case for the store, which contains a description of functionality supported by the server. Implements the FHIR standard capabilities interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#capabilities), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#capabilities)), or the [conformance interaction](http://hl7.org/implement/standards/fhir/DSTU2/http.html#conformance) in the DSTU2 case. On success, the response body will contain a JSON-encoded representation of a `CapabilityStatement` resource. * @example * * // BEFORE RUNNING: * // --------------- @@ -9085,7 +9093,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalDelete - * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1)). If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. + * @desc Deletes FHIR resources that match a search query. Implements the FHIR standard conditional delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.12.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.13.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#3.1.0.7.1)). If multiple resources match, all of them will be deleted. Search terms are provided as query parameters following the same pattern as the search method. Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. * @example * * // BEFORE RUNNING: * // --------------- @@ -9139,7 +9147,7 @@ export namespace healthcare_v1beta1 { * * @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 FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). + * @param {string} params.type The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -9206,7 +9214,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalPatch - * @desc If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc If a resource is found based on the search criteria specified in the query parameters, updates part of that resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard conditional patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)). DSTU2 doesn't define a conditional patch method, but the server supports it in the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9268,7 +9276,7 @@ export namespace healthcare_v1beta1 { * * @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 FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). + * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). * @param {().HttpBody} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9336,7 +9344,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.conditionalUpdate - * @desc If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource will be created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc If a resource is found based on the search criteria specified in the query parameters, updates the entire contents of that resource. Implements the FHIR standard conditional update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.10.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cond-update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#cond-update)). Search terms are provided as query parameters following the same pattern as the search method. If the search criteria identify more than one match, the request will return a `412 Precondition Failed` error. If the search criteria identify zero matches, and the supplied resource body contains an `id`, and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. If the search criteria identify zero matches, and the supplied resource body does not contain an `id`, the resource will be created with a server-assigned ID as per the create method. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9399,7 +9407,7 @@ export namespace healthcare_v1beta1 { * * @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 FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). Must match the resource type in the provided content. + * @param {string} params.type The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. * @param {().HttpBody} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9467,7 +9475,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.create - * @desc Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Creates a FHIR resource. Implements the FHIR standard create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#create), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#create), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#create)), which creates a new resource with a server-assigned resource ID. Also supports the FHIR standard conditional create interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#ccreate), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#ccreate), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#ccreate)), specified by supplying an `If-None-Exist` header containing a FHIR search query. If no resources match this search query, the server processes the create operation as normal. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. On success, the response body will contain a JSON-encoded representation of the resource as it was created on the server, including the server-assigned resource ID and version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9529,7 +9537,7 @@ export namespace healthcare_v1beta1 { * * @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 FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). Must match the resource type in the provided content. + * @param {string} params.type The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. * @param {().HttpBody} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -9597,7 +9605,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.delete - * @desc Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. + * @desc Deletes a FHIR resource. Implements the FHIR standard delete interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#delete), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#delete), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#delete)). Note: Unless resource versioning is disabled by setting the disable_resource_versioning flag on the FHIR store, the deleted resources will be moved to a history repository that can still be retrieved through vread and related methods, unless they are removed by the purge method. * @example * * // BEFORE RUNNING: * // --------------- @@ -9712,7 +9720,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.executeBundle - * @desc Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1)) and transaction processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Executes all the requests in the given Bundle. Implements the FHIR standard batch/transaction interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#transaction), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#transaction), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#transaction)). Supports all interactions within a bundle, except search. This method accepts Bundles of type `batch` and `transaction`, processing them according to the batch processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.1), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.1), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#brules)) and transaction processing rules ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#2.1.0.16.2), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#2.21.0.17.2), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#trules)). The request body must contain a JSON-encoded FHIR `Bundle` resource, and the request headers must contain `Content-Type: application/fhir+json`. For a batch bundle or a successful transaction the response body will contain a JSON-encoded representation of a `Bundle` resource of type `batch-response` or `transaction-response` containing one entry for each entry in the request, with the outcome of processing the entry. In the case of an error for a transaction bundle, the response body will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9835,7 +9843,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.history - * @desc Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history)). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Lists all the versions of a resource (including the current version and deleted versions) from the FHIR store. Implements the per-resource form of the FHIR standard history interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#history), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#history), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#history)). On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `history`, containing the version history sorted from most recent to oldest versions. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -9957,7 +9965,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.Observation-lastn - * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Retrieves the N most recent `Observation` resources for a subject matching search criteria specified as query parameters, grouped by `Observation.code`, sorted from most recent to oldest. Implements the FHIR extended operation Observation-lastn ([STU3](http://hl7.org/implement/standards/fhir/STU3/observation-operations.html#lastn), [R4](http://hl7.org/implement/standards/fhir/R4/observation-operations.html#lastn)). DSTU2 doesn't define the Observation-lastn method, but the server supports it the same way it supports STU3. Search terms are provided as query parameters following the same pattern as the search method. The following search parameters must be provided: - `subject` or `patient` to specify a subject for the Observation. - `code`, `category` or any of the composite parameters that include `code`. Any other valid Observation search parameters can also be provided. This operation accepts an additional query parameter `max`, which specifies N, the maximum number of Observations to return from each group, with a default of 1. Searches with over 1000 results are rejected. Results are counted before grouping and limiting the results with `max`. To stay within the limit, constrain these searches using Observation search parameters such as `_lastUpdated` or `date`. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the operation. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -10074,7 +10082,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.patch - * @desc Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch)). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Updates part of an existing resource by applying the operations specified in a [JSON Patch](http://jsonpatch.com/) document. Implements the FHIR standard patch interaction ([STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#patch), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#patch)]). DSTU2 doesn't define a patch method, but the server supports it in the same way it supports STU3. The request body must contain a JSON Patch document, and the request headers must contain `Content-Type: application/json-patch+json`. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -10317,7 +10325,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.read - * @desc Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Gets the contents of a FHIR resource. Implements the FHIR standard read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#read), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#read), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#read)). Also supports the FHIR standard conditional read interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#cread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#cread), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#cread)) specified by supplying an `If-Modified-Since` header with a date/time value or an `If-None-Match` header with an ETag value. On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -10547,7 +10555,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.search - * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html)). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. + * @desc Searches for resources in the given FHIR store according to criteria specified as query parameters. Implements the FHIR standard search interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#search), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#search), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#search)) using the search semantics described in the FHIR Search specification ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/search.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/search.html), [R4](http://hl7.org/implement/standards/fhir/R4/search.html)). Supports three methods of search defined by the specification: * `GET [base]?[parameters]` to search across all resources. * `GET [base]/[type]?[parameters]` to search resources of a specified type. * `POST [base]/[type]/_search?[parameters]` as an alternate form having the same semantics as the `GET` method. The `GET` methods do not support compartment searches. The `POST` method does not support `application/x-www-form-urlencoded` search parameters. On success, the response body will contain a JSON-encoded representation of a `Bundle` resource of type `searchset`, containing the results of the search. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. The server's capability statement, retrieved through capabilities, indicates what search parameters are supported on each FHIR resource. A list of all search parameters defined by the specification can be found in the FHIR Search Parameter Registry ([STU3](http://hl7.org/implement/standards/fhir/STU3/searchparameter-registry.html), [R4](http://hl7.org/implement/standards/fhir/R4/searchparameter-registry.html)). FHIR search parameters for DSTU2 can be found on each resource's definition page. Supported search modifiers: `:missing`, `:exact`, `:contains`, `:text`, `:in`, `:not-in`, `:above`, `:below`, `:[type]`, `:not`, and `:recurse`. Supported search result parameters: `_sort`, `_count`, `_include`, `_revinclude`, `_summary=text`, `_summary=data`, and `_elements`. The maximum number of search results returned defaults to 100, which can be overridden by the `_count` parameter up to a maximum limit of 1000. If there are additional results, the returned `Bundle` will contain pagination links. Resources with a total size larger than 5MB or a field count larger than 50,000 might not be fully searchable as the server might trim its generated search index in those cases. Note: FHIR resources are indexed asynchronously, so there might be a slight delay between the time a resource is created or changes and when the change is reflected in search results. * @example * * // BEFORE RUNNING: * // --------------- @@ -10670,7 +10678,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.update - * @desc Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Updates the entire contents of a resource. Implements the FHIR standard update interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#update), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#update), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#update)). If the specified resource does not exist and the FHIR store has enable_update_create set, creates the resource with the client-specified ID. The request body must contain a JSON-encoded FHIR resource, and the request headers must contain `Content-Type: application/fhir+json`. The resource must contain an `id` element having an identical value to the ID in the REST path of the request. On success, the response body will contain a JSON-encoded representation of the updated resource, including the server-assigned version ID. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -10791,7 +10799,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.fhirStores.fhir.vread - * @desc Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread). On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. + * @desc Gets the contents of a version (current or historical) of a FHIR resource by version ID. Implements the FHIR standard vread interaction ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/http.html#vread), [STU3](http://hl7.org/implement/standards/fhir/STU3/http.html#vread), [R4](http://hl7.org/implement/standards/fhir/R4/http.html#vread)). On success, the response body will contain a JSON-encoded representation of the resource. Errors generated by the FHIR store will contain a JSON-encoded `OperationOutcome` resource describing the reason for the error. If the request cannot be mapped to a valid API method on a FHIR store, a generic GCP error might be returned instead. * @example * * // BEFORE RUNNING: * // --------------- @@ -10929,7 +10937,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). + * The FHIR resource type to delete, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). */ type?: string; } @@ -10945,7 +10953,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). + * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). */ type?: string; @@ -10966,7 +10974,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). Must match the resource type in the provided content. + * The FHIR resource type to update, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -10987,7 +10995,7 @@ export namespace healthcare_v1beta1 { */ parent?: string; /** - * The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html)). Must match the resource type in the provided content. + * The FHIR resource type to create, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](http://hl7.org/implement/standards/fhir/DSTU2/resourcelist.html), [STU3](http://hl7.org/implement/standards/fhir/STU3/resourcelist.html), [R4](http://hl7.org/implement/standards/fhir/R4/resourcelist.html)). Must match the resource type in the provided content. */ type?: string; @@ -12883,6 +12891,7 @@ export namespace healthcare_v1beta1 { * @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.view Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -12953,7 +12962,7 @@ export namespace healthcare_v1beta1 { /** * healthcare.projects.locations.datasets.hl7V2Stores.messages.patch - * @desc Update the message. + * @desc Update the message. The contents of the message in Message.data and data extracted from the contents such as Message.create_time cannot be altered. Only the Message.labels field is allowed to be updated. The labels in the request are merged with the existing set of labels. Existing labels with the same keys are updated. * @example * * // BEFORE RUNNING: * // --------------- @@ -13012,7 +13021,7 @@ export namespace healthcare_v1beta1 { * * @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 are merged with the existing set of labels. Existing labels with the same keys are updated. + * @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 {().Message} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -13165,6 +13174,10 @@ export namespace healthcare_v1beta1 { * Name of the HL7v2 store to retrieve messages from. */ parent?: string; + /** + * Specifies the parts of the Message to return in the response. When unspecified, equivalent to BASIC. + */ + view?: string; } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Messages$Patch extends StandardParameters { @@ -13178,7 +13191,7 @@ export namespace healthcare_v1beta1 { */ 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 are merged with the existing set of labels. Existing labels with the same keys are updated. + * 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; diff --git a/src/apis/homegraph/v1.ts b/src/apis/homegraph/v1.ts index cc16c37491..e120315f63 100644 --- a/src/apis/homegraph/v1.ts +++ b/src/apis/homegraph/v1.ts @@ -321,7 +321,7 @@ export namespace homegraph_v1 { */ followUpToken?: string | null; /** - * State of devices to update and notification metadata for devices. For example, if a user turns a light on manually, a state update should be sent so that the information is always the current status of the device. Notifications are independent from the state and its piece of the payload should contain everything necessary to notify the user. Although it may be related to a state change, it does not need to be. For example, if a device can turn on/off and change temperature, the states reported would include both "on" and "70 degrees" but the 3p may choose not to send any notification for that, or to only say that the "the room is heating up", keeping state and notification independent. + * Required. State of devices to update and notification metadata for devices. For example, if a user turns a light on manually, a state update should be sent so that the information is always the current status of the device. Notifications are independent from the state and its piece of the payload should contain everything necessary to notify the user. Although it may be related to a state change, it does not need to be. For example, if a device can turn on/off and change temperature, the states reported would include both "on" and "70 degrees" but the 3p may choose not to send any notification for that, or to only say that the "the room is heating up", keeping state and notification independent. */ payload?: Schema$StateAndNotificationPayload; /** diff --git a/src/apis/iam/v1.ts b/src/apis/iam/v1.ts index 1409df99cc..20d8d5b052 100644 --- a/src/apis/iam/v1.ts +++ b/src/apis/iam/v1.ts @@ -266,23 +266,23 @@ export namespace iam_v1 { */ export interface Schema$EnableServiceAccountRequest {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index b629eaf0ff..3206a95792 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -103,7 +103,7 @@ export namespace iap_v1 { */ export class Iap { context: APIRequestContext; - oauth: Resource$Oauth; + projects: Resource$Projects; v1: Resource$V1; constructor(options: GlobalOptions, google?: GoogleConfigurable) { @@ -112,7 +112,7 @@ export namespace iap_v1 { google, }; - this.oauth = new Resource$Oauth(this.context); + this.projects = new Resource$Projects(this.context); this.v1 = new Resource$V1(this.context); } } @@ -204,23 +204,23 @@ export namespace iap_v1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -312,9 +312,13 @@ export namespace iap_v1 { nextPageToken?: string | null; } /** - * Configuration for OAuth login&consent flow behavior. + * Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials. */ export interface Schema$OAuthSettings { + /** + * OAuth 2.0 client ID used in the OAuth flow to generate an access token. If this field is set, you can skip obtaining the OAuth credentials in this step: https://developers.google.com/identity/protocols/OAuth2?hl=en_US#1.-obtain-oauth-2.0-credentials-from-the-google-api-console. However, this could allow for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks. + */ + clientId?: string | null; /** * Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies. */ @@ -369,38 +373,29 @@ export namespace iap_v1 { permissions?: string[] | null; } - export class Resource$Oauth { - context: APIRequestContext; - projects: Resource$Oauth$Projects; - constructor(context: APIRequestContext) { - this.context = context; - this.projects = new Resource$Oauth$Projects(this.context); - } - } - - export class Resource$Oauth$Projects { + export class Resource$Projects { context: APIRequestContext; - brands: Resource$Oauth$Projects$Brands; + brands: Resource$Projects$Brands; constructor(context: APIRequestContext) { this.context = context; - this.brands = new Resource$Oauth$Projects$Brands(this.context); + this.brands = new Resource$Projects$Brands(this.context); } } - export class Resource$Oauth$Projects$Brands { + export class Resource$Projects$Brands { context: APIRequestContext; - identityAwareProxyClients: Resource$Oauth$Projects$Brands$Identityawareproxyclients; + identityAwareProxyClients: Resource$Projects$Brands$Identityawareproxyclients; constructor(context: APIRequestContext) { this.context = context; - this.identityAwareProxyClients = new Resource$Oauth$Projects$Brands$Identityawareproxyclients( + this.identityAwareProxyClients = new Resource$Projects$Brands$Identityawareproxyclients( this.context ); } /** - * iap.oauth.projects.brands.create + * iap.projects.brands.create * @desc Constructs a new OAuth brand for the project if one does not exist. The created brand is "internal only", meaning that OAuth clients created under it only accept requests from users who belong to the same G Suite organization as the project. The brand is created in an un-reviewed status. NOTE: The "internal only" status can be manually changed in the Google Cloud console. Requires that a brand does not already exist for the project, and that the specified support email is owned by the caller. - * @alias iap.oauth.projects.brands.create + * @alias iap.projects.brands.create * @memberOf! () * * @param {object} params Parameters for request @@ -411,33 +406,33 @@ export namespace iap_v1 { * @return {object} Request object */ create( - params?: Params$Resource$Oauth$Projects$Brands$Create, + params?: Params$Resource$Projects$Brands$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Oauth$Projects$Brands$Create, + params: Params$Resource$Projects$Brands$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Oauth$Projects$Brands$Create, + params: Params$Resource$Projects$Brands$Create, callback: BodyResponseCallback ): void; create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Oauth$Projects$Brands$Create + | Params$Resource$Projects$Brands$Create | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Oauth$Projects$Brands$Create; + {}) as Params$Resource$Projects$Brands$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Oauth$Projects$Brands$Create; + params = {} as Params$Resource$Projects$Brands$Create; options = {}; } @@ -450,7 +445,7 @@ export namespace iap_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/oauth/{+parent}/brands').replace( + url: (rootUrl + '/v1/{+parent}/brands').replace( /([^:]\/)\/+/g, '$1' ), @@ -471,9 +466,9 @@ export namespace iap_v1 { } /** - * iap.oauth.projects.brands.get + * iap.projects.brands.get * @desc Retrieves the OAuth brand of the project. - * @alias iap.oauth.projects.brands.get + * @alias iap.projects.brands.get * @memberOf! () * * @param {object} params Parameters for request @@ -483,33 +478,33 @@ export namespace iap_v1 { * @return {object} Request object */ get( - params?: Params$Resource$Oauth$Projects$Brands$Get, + params?: Params$Resource$Projects$Brands$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Oauth$Projects$Brands$Get, + params: Params$Resource$Projects$Brands$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Oauth$Projects$Brands$Get, + params: Params$Resource$Projects$Brands$Get, callback: BodyResponseCallback ): void; get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Oauth$Projects$Brands$Get + | Params$Resource$Projects$Brands$Get | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Oauth$Projects$Brands$Get; + {}) as Params$Resource$Projects$Brands$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Oauth$Projects$Brands$Get; + params = {} as Params$Resource$Projects$Brands$Get; options = {}; } @@ -522,7 +517,7 @@ export namespace iap_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/oauth/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -540,9 +535,9 @@ export namespace iap_v1 { } /** - * iap.oauth.projects.brands.list + * iap.projects.brands.list * @desc Lists the existing brands for the project. - * @alias iap.oauth.projects.brands.list + * @alias iap.projects.brands.list * @memberOf! () * * @param {object} params Parameters for request @@ -552,22 +547,22 @@ export namespace iap_v1 { * @return {object} Request object */ list( - params?: Params$Resource$Oauth$Projects$Brands$List, + params?: Params$Resource$Projects$Brands$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Oauth$Projects$Brands$List, + params: Params$Resource$Projects$Brands$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Oauth$Projects$Brands$List, + params: Params$Resource$Projects$Brands$List, callback: BodyResponseCallback ): void; list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Oauth$Projects$Brands$List + | Params$Resource$Projects$Brands$List | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -575,12 +570,12 @@ export namespace iap_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Oauth$Projects$Brands$List; + {}) as Params$Resource$Projects$Brands$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Oauth$Projects$Brands$List; + params = {} as Params$Resource$Projects$Brands$List; options = {}; } @@ -593,7 +588,7 @@ export namespace iap_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/oauth/{+parent}/brands').replace( + url: (rootUrl + '/v1/{+parent}/brands').replace( /([^:]\/)\/+/g, '$1' ), @@ -614,7 +609,7 @@ export namespace iap_v1 { } } - export interface Params$Resource$Oauth$Projects$Brands$Create + export interface Params$Resource$Projects$Brands$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -631,7 +626,7 @@ export namespace iap_v1 { */ requestBody?: Schema$Brand; } - export interface Params$Resource$Oauth$Projects$Brands$Get + export interface Params$Resource$Projects$Brands$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -643,7 +638,7 @@ export namespace iap_v1 { */ name?: string; } - export interface Params$Resource$Oauth$Projects$Brands$List + export interface Params$Resource$Projects$Brands$List extends StandardParameters { /** * Auth client or API Key for the request @@ -656,16 +651,16 @@ export namespace iap_v1 { parent?: string; } - export class Resource$Oauth$Projects$Brands$Identityawareproxyclients { + export class Resource$Projects$Brands$Identityawareproxyclients { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * iap.oauth.projects.brands.identityAwareProxyClients.create + * iap.projects.brands.identityAwareProxyClients.create * @desc Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use. - * @alias iap.oauth.projects.brands.identityAwareProxyClients.create + * @alias iap.projects.brands.identityAwareProxyClients.create * @memberOf! () * * @param {object} params Parameters for request @@ -676,18 +671,18 @@ export namespace iap_v1 { * @return {object} Request object */ create( - params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create, + params?: Params$Resource$Projects$Brands$Identityawareproxyclients$Create, options?: MethodOptions ): GaxiosPromise; create( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$Create, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$Create, callback: BodyResponseCallback ): void; create( @@ -695,7 +690,7 @@ export namespace iap_v1 { ): void; create( paramsOrCallback?: - | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create + | Params$Resource$Projects$Brands$Identityawareproxyclients$Create | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -703,12 +698,12 @@ export namespace iap_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create; + {}) as Params$Resource$Projects$Brands$Identityawareproxyclients$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create; + params = {} as Params$Resource$Projects$Brands$Identityawareproxyclients$Create; options = {}; } @@ -721,9 +716,10 @@ export namespace iap_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/oauth/{+parent}/identityAwareProxyClients' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/identityAwareProxyClients').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'POST', }, options @@ -741,9 +737,9 @@ export namespace iap_v1 { } /** - * iap.oauth.projects.brands.identityAwareProxyClients.delete + * iap.projects.brands.identityAwareProxyClients.delete * @desc Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP. - * @alias iap.oauth.projects.brands.identityAwareProxyClients.delete + * @alias iap.projects.brands.identityAwareProxyClients.delete * @memberOf! () * * @param {object} params Parameters for request @@ -753,33 +749,33 @@ export namespace iap_v1 { * @return {object} Request object */ delete( - params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete, + params?: Params$Resource$Projects$Brands$Identityawareproxyclients$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete + | Params$Resource$Projects$Brands$Identityawareproxyclients$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete; + {}) as Params$Resource$Projects$Brands$Identityawareproxyclients$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete; + params = {} as Params$Resource$Projects$Brands$Identityawareproxyclients$Delete; options = {}; } @@ -792,7 +788,7 @@ export namespace iap_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/oauth/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', }, options @@ -810,9 +806,9 @@ export namespace iap_v1 { } /** - * iap.oauth.projects.brands.identityAwareProxyClients.get + * iap.projects.brands.identityAwareProxyClients.get * @desc Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP. - * @alias iap.oauth.projects.brands.identityAwareProxyClients.get + * @alias iap.projects.brands.identityAwareProxyClients.get * @memberOf! () * * @param {object} params Parameters for request @@ -822,24 +818,24 @@ export namespace iap_v1 { * @return {object} Request object */ get( - params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get, + params?: Params$Resource$Projects$Brands$Identityawareproxyclients$Get, options?: MethodOptions ): GaxiosPromise; get( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$Get, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$Get, callback: BodyResponseCallback ): void; get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get + | Params$Resource$Projects$Brands$Identityawareproxyclients$Get | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -847,12 +843,12 @@ export namespace iap_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get; + {}) as Params$Resource$Projects$Brands$Identityawareproxyclients$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get; + params = {} as Params$Resource$Projects$Brands$Identityawareproxyclients$Get; options = {}; } @@ -865,7 +861,7 @@ export namespace iap_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/oauth/{+name}').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -883,9 +879,9 @@ export namespace iap_v1 { } /** - * iap.oauth.projects.brands.identityAwareProxyClients.list + * iap.projects.brands.identityAwareProxyClients.list * @desc Lists the existing clients for the brand. - * @alias iap.oauth.projects.brands.identityAwareProxyClients.list + * @alias iap.projects.brands.identityAwareProxyClients.list * @memberOf! () * * @param {object} params Parameters for request @@ -897,11 +893,11 @@ export namespace iap_v1 { * @return {object} Request object */ list( - params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List, + params?: Params$Resource$Projects$Brands$Identityawareproxyclients$List, options?: MethodOptions ): GaxiosPromise; list( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$List, options: | MethodOptions | BodyResponseCallback, @@ -910,7 +906,7 @@ export namespace iap_v1 { > ): void; list( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$List, callback: BodyResponseCallback< Schema$ListIdentityAwareProxyClientsResponse > @@ -922,7 +918,7 @@ export namespace iap_v1 { ): void; list( paramsOrCallback?: - | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List + | Params$Resource$Projects$Brands$Identityawareproxyclients$List | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -932,12 +928,12 @@ export namespace iap_v1 { > ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List; + {}) as Params$Resource$Projects$Brands$Identityawareproxyclients$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List; + params = {} as Params$Resource$Projects$Brands$Identityawareproxyclients$List; options = {}; } @@ -950,9 +946,10 @@ export namespace iap_v1 { const parameters = { options: Object.assign( { - url: ( - rootUrl + '/v1/oauth/{+parent}/identityAwareProxyClients' - ).replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v1/{+parent}/identityAwareProxyClients').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -975,9 +972,9 @@ export namespace iap_v1 { } /** - * iap.oauth.projects.brands.identityAwareProxyClients.resetSecret + * iap.projects.brands.identityAwareProxyClients.resetSecret * @desc Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP. - * @alias iap.oauth.projects.brands.identityAwareProxyClients.resetSecret + * @alias iap.projects.brands.identityAwareProxyClients.resetSecret * @memberOf! () * * @param {object} params Parameters for request @@ -988,18 +985,18 @@ export namespace iap_v1 { * @return {object} Request object */ resetSecret( - params?: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret, + params?: Params$Resource$Projects$Brands$Identityawareproxyclients$Resetsecret, options?: MethodOptions ): GaxiosPromise; resetSecret( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$Resetsecret, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; resetSecret( - params: Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret, + params: Params$Resource$Projects$Brands$Identityawareproxyclients$Resetsecret, callback: BodyResponseCallback ): void; resetSecret( @@ -1007,7 +1004,7 @@ export namespace iap_v1 { ): void; resetSecret( paramsOrCallback?: - | Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret + | Params$Resource$Projects$Brands$Identityawareproxyclients$Resetsecret | BodyResponseCallback, optionsOrCallback?: | MethodOptions @@ -1015,12 +1012,12 @@ export namespace iap_v1 { callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret; + {}) as Params$Resource$Projects$Brands$Identityawareproxyclients$Resetsecret; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret; + params = {} as Params$Resource$Projects$Brands$Identityawareproxyclients$Resetsecret; options = {}; } @@ -1033,7 +1030,7 @@ export namespace iap_v1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1/oauth/{+name}:resetSecret').replace( + url: (rootUrl + '/v1/{+name}:resetSecret').replace( /([^:]\/)\/+/g, '$1' ), @@ -1054,7 +1051,7 @@ export namespace iap_v1 { } } - export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Create + export interface Params$Resource$Projects$Brands$Identityawareproxyclients$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -1071,7 +1068,7 @@ export namespace iap_v1 { */ requestBody?: Schema$IdentityAwareProxyClient; } - export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Delete + export interface Params$Resource$Projects$Brands$Identityawareproxyclients$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -1083,7 +1080,7 @@ export namespace iap_v1 { */ name?: string; } - export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Get + export interface Params$Resource$Projects$Brands$Identityawareproxyclients$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -1095,7 +1092,7 @@ export namespace iap_v1 { */ name?: string; } - export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$List + export interface Params$Resource$Projects$Brands$Identityawareproxyclients$List extends StandardParameters { /** * Auth client or API Key for the request @@ -1115,7 +1112,7 @@ export namespace iap_v1 { */ parent?: string; } - export interface Params$Resource$Oauth$Projects$Brands$Identityawareproxyclients$Resetsecret + export interface Params$Resource$Projects$Brands$Identityawareproxyclients$Resetsecret extends StandardParameters { /** * Auth client or API Key for the request diff --git a/src/apis/iap/v1beta1.ts b/src/apis/iap/v1beta1.ts index ac74aa1178..9f1aa98f23 100644 --- a/src/apis/iap/v1beta1.ts +++ b/src/apis/iap/v1beta1.ts @@ -133,23 +133,23 @@ export namespace iap_v1beta1 { role?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/index.ts b/src/apis/index.ts index c2a79f059c..dcfd5304b3 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -21,6 +21,7 @@ import * as adexchangebuyer from './adexchangebuyer'; import * as adexchangebuyer2 from './adexchangebuyer2'; import * as adexperiencereport from './adexperiencereport'; import * as admin from './admin'; +import * as admob from './admob'; import * as adsense from './adsense'; import * as adsensehost from './adsensehost'; import * as alertcenter from './alertcenter'; @@ -98,7 +99,6 @@ import * as firebaserules from './firebaserules'; import * as firestore from './firestore'; import * as fitness from './fitness'; import * as games from './games'; -import * as gamesConfiguration from './gamesConfiguration'; import * as gamesManagement from './gamesManagement'; import * as genomics from './genomics'; import * as gmail from './gmail'; @@ -123,12 +123,12 @@ import * as mirror from './mirror'; import * as ml from './ml'; import * as monitoring from './monitoring'; import * as oauth2 from './oauth2'; +import * as osconfig from './osconfig'; import * as oslogin from './oslogin'; import * as pagespeedonline from './pagespeedonline'; import * as people from './people'; import * as playcustomapp from './playcustomapp'; import * as plus from './plus'; -import * as plusDomains from './plusDomains'; import * as policytroubleshooter from './policytroubleshooter'; import * as poly from './poly'; import * as prod_tt_sasportal from './prod_tt_sasportal'; @@ -137,16 +137,15 @@ import * as pubsub from './pubsub'; import * as recommender from './recommender'; import * as redis from './redis'; import * as remotebuildexecution from './remotebuildexecution'; -import * as replicapool from './replicapool'; import * as reseller from './reseller'; import * as run from './run'; import * as runtimeconfig from './runtimeconfig'; import * as safebrowsing from './safebrowsing'; import * as sasportal from './sasportal'; import * as script from './script'; +import * as searchconsole from './searchconsole'; import * as secretmanager from './secretmanager'; import * as securitycenter from './securitycenter'; -import * as servicebroker from './servicebroker'; import * as serviceconsumermanagement from './serviceconsumermanagement'; import * as servicecontrol from './servicecontrol'; import * as servicemanagement from './servicemanagement'; @@ -194,6 +193,7 @@ export const APIS: APIList = { adexchangebuyer2: adexchangebuyer2.VERSIONS, adexperiencereport: adexperiencereport.VERSIONS, admin: admin.VERSIONS, + admob: admob.VERSIONS, adsense: adsense.VERSIONS, adsensehost: adsensehost.VERSIONS, alertcenter: alertcenter.VERSIONS, @@ -271,7 +271,6 @@ export const APIS: APIList = { firestore: firestore.VERSIONS, fitness: fitness.VERSIONS, games: games.VERSIONS, - gamesConfiguration: gamesConfiguration.VERSIONS, gamesManagement: gamesManagement.VERSIONS, genomics: genomics.VERSIONS, gmail: gmail.VERSIONS, @@ -296,12 +295,12 @@ export const APIS: APIList = { ml: ml.VERSIONS, monitoring: monitoring.VERSIONS, oauth2: oauth2.VERSIONS, + osconfig: osconfig.VERSIONS, oslogin: oslogin.VERSIONS, pagespeedonline: pagespeedonline.VERSIONS, people: people.VERSIONS, playcustomapp: playcustomapp.VERSIONS, plus: plus.VERSIONS, - plusDomains: plusDomains.VERSIONS, policytroubleshooter: policytroubleshooter.VERSIONS, poly: poly.VERSIONS, prod_tt_sasportal: prod_tt_sasportal.VERSIONS, @@ -310,16 +309,15 @@ export const APIS: APIList = { recommender: recommender.VERSIONS, redis: redis.VERSIONS, remotebuildexecution: remotebuildexecution.VERSIONS, - replicapool: replicapool.VERSIONS, reseller: reseller.VERSIONS, run: run.VERSIONS, runtimeconfig: runtimeconfig.VERSIONS, safebrowsing: safebrowsing.VERSIONS, sasportal: sasportal.VERSIONS, script: script.VERSIONS, + searchconsole: searchconsole.VERSIONS, secretmanager: secretmanager.VERSIONS, securitycenter: securitycenter.VERSIONS, - servicebroker: servicebroker.VERSIONS, serviceconsumermanagement: serviceconsumermanagement.VERSIONS, servicecontrol: servicecontrol.VERSIONS, servicemanagement: servicemanagement.VERSIONS, @@ -363,6 +361,7 @@ export class GeneratedAPIs { adexchangebuyer2 = adexchangebuyer2.adexchangebuyer2; adexperiencereport = adexperiencereport.adexperiencereport; admin = admin.admin; + admob = admob.admob; adsense = adsense.adsense; adsensehost = adsensehost.adsensehost; alertcenter = alertcenter.alertcenter; @@ -442,7 +441,6 @@ export class GeneratedAPIs { firestore = firestore.firestore; fitness = fitness.fitness; games = games.games; - gamesConfiguration = gamesConfiguration.gamesConfiguration; gamesManagement = gamesManagement.gamesManagement; genomics = genomics.genomics; gmail = gmail.gmail; @@ -467,12 +465,12 @@ export class GeneratedAPIs { ml = ml.ml; monitoring = monitoring.monitoring; oauth2 = oauth2.oauth2; + osconfig = osconfig.osconfig; oslogin = oslogin.oslogin; pagespeedonline = pagespeedonline.pagespeedonline; people = people.people; playcustomapp = playcustomapp.playcustomapp; plus = plus.plus; - plusDomains = plusDomains.plusDomains; policytroubleshooter = policytroubleshooter.policytroubleshooter; poly = poly.poly; prod_tt_sasportal = prod_tt_sasportal.prod_tt_sasportal; @@ -481,16 +479,15 @@ export class GeneratedAPIs { recommender = recommender.recommender; redis = redis.redis; remotebuildexecution = remotebuildexecution.remotebuildexecution; - replicapool = replicapool.replicapool; reseller = reseller.reseller; run = run.run; runtimeconfig = runtimeconfig.runtimeconfig; safebrowsing = safebrowsing.safebrowsing; sasportal = sasportal.sasportal; script = script.script; + searchconsole = searchconsole.searchconsole; secretmanager = secretmanager.secretmanager; securitycenter = securitycenter.securitycenter; - servicebroker = servicebroker.servicebroker; serviceconsumermanagement = serviceconsumermanagement.serviceconsumermanagement; servicecontrol = servicecontrol.servicecontrol; diff --git a/src/apis/jobs/v3.ts b/src/apis/jobs/v3.ts index 42b5c8275e..a8ae712a4a 100644 --- a/src/apis/jobs/v3.ts +++ b/src/apis/jobs/v3.ts @@ -1146,7 +1146,7 @@ export namespace jobs_v3 { */ jobView?: string | null; /** - * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). + * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). */ offset?: number | null; /** diff --git a/src/apis/jobs/v3p1beta1.ts b/src/apis/jobs/v3p1beta1.ts index dec24bacab..383bafc9c5 100644 --- a/src/apis/jobs/v3p1beta1.ts +++ b/src/apis/jobs/v3p1beta1.ts @@ -527,7 +527,7 @@ export namespace jobs_v3p1beta1 { */ importanceLevel?: string | null; /** - * Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). The product of ranking expression and relevance score is used to determine job's final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5) + * Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number. Parenthesis are supported to adjust calculation precedence. The expression must be < 100 characters in length. The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5) */ rankingExpression?: string | null; } @@ -1218,7 +1218,7 @@ export namespace jobs_v3p1beta1 { */ jobView?: string | null; /** - * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). + * Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page). */ offset?: number | null; /** diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index c885576371..394bd0b605 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -107,11 +107,13 @@ export namespace logging_v2 { entries: Resource$Entries; exclusions: Resource$Exclusions; folders: Resource$Folders; + locations: Resource$Locations; logs: Resource$Logs; monitoredResourceDescriptors: Resource$Monitoredresourcedescriptors; organizations: Resource$Organizations; projects: Resource$Projects; sinks: Resource$Sinks; + v2: Resource$V2; constructor(options: GlobalOptions, google?: GoogleConfigurable) { this.context = { @@ -123,6 +125,7 @@ export namespace logging_v2 { this.entries = new Resource$Entries(this.context); this.exclusions = new Resource$Exclusions(this.context); this.folders = new Resource$Folders(this.context); + this.locations = new Resource$Locations(this.context); this.logs = new Resource$Logs(this.context); this.monitoredResourceDescriptors = new Resource$Monitoredresourcedescriptors( this.context @@ -130,6 +133,7 @@ export namespace logging_v2 { this.organizations = new Resource$Organizations(this.context); this.projects = new Resource$Projects(this.context); this.sinks = new Resource$Sinks(this.context); + this.v2 = new Resource$V2(this.context); } } @@ -141,6 +145,10 @@ export namespace logging_v2 { * Optional. Whether to use BigQuery's partition tables. By default, Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax has to be used instead. In both cases, tables are sharded based on UTC timezone. */ usePartitionedTables?: boolean | null; + /** + * Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use. All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false. + */ + usesTimestampColumnPartitioning?: boolean | null; } /** * 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. @@ -159,6 +167,23 @@ export namespace logging_v2 { */ linearBuckets?: Schema$Linear; } + /** + * Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information. + */ + export interface Schema$CmekSettings { + /** + * The resource name for the configured Cloud KMS key.KMS key name format: "projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY"For example: "projects/my-project-id/locations/my-region/keyRings/key-ring-name/cryptoKeys/key-name"To enable CMEK for the Logs Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Logs Router, set this field to an empty string.See Enabling CMEK for Logs Router for more information. + */ + kmsKeyName?: string | null; + /** + * Output Only. The resource name of the CMEK settings. + */ + name?: string | null; + /** + * Output Only. The service account that will be used by the Logs Router to access your Cloud KMS key.Before enabling CMEK for Logs Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Logs Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Logs Router for more information. + */ + serviceAccountId?: string | null; + } /** * 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 {}. */ @@ -288,6 +313,19 @@ export namespace logging_v2 { */ width?: number | null; } + /** + * The response from ListBuckets (Beta). + */ + export interface Schema$ListBucketsResponse { + /** + * A list of buckets. + */ + buckets?: Schema$LogBucket[]; + /** + * 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 | null; + } /** * Result returned from ListExclusions. */ @@ -395,6 +433,35 @@ export namespace logging_v2 { */ sinks?: Schema$LogSink[]; } + /** + * Describes a repository of logs (Beta). + */ + export interface Schema$LogBucket { + /** + * Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. + */ + createTime?: string | null; + /** + * Describes this bucket. + */ + description?: string | null; + /** + * The bucket lifecycle state.Output only. + */ + lifecycleState?: string | null; + /** + * The resource name of the bucket. For example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id The supported locations are: "global" "us-central1"For the location of global it is unspecified where logs are actually stored. Once a bucket has been created, the location can not be changed. + */ + name?: string | null; + /** + * Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. + */ + retentionDays?: number | null; + /** + * Output only. The last update timestamp of the bucket. + */ + updateTime?: string | null; + } /** * An individual entry in a log. */ @@ -404,7 +471,7 @@ export namespace logging_v2 { */ 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. + * 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 are removed in a single query result. However, there are no guarantees of de-duplication in the export of logs.If the insert_id is omitted when writing a log entry, the Logging API assigns its own unique identifier in this field.In queries, the insert_id is also used to order log entries that have the same log_name and timestamp values. */ insertId?: string | null; /** @@ -699,7 +766,7 @@ export namespace logging_v2 { */ type?: string | null; /** - * Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.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. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). + * The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed..If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).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) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.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. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). */ unit?: string | null; /** @@ -982,17 +1049,112 @@ export namespace logging_v2 { export class Resource$Billingaccounts { context: APIRequestContext; + buckets: Resource$Billingaccounts$Buckets; exclusions: Resource$Billingaccounts$Exclusions; + locations: Resource$Billingaccounts$Locations; logs: Resource$Billingaccounts$Logs; sinks: Resource$Billingaccounts$Sinks; constructor(context: APIRequestContext) { this.context = context; + this.buckets = new Resource$Billingaccounts$Buckets(this.context); this.exclusions = new Resource$Billingaccounts$Exclusions(this.context); + this.locations = new Resource$Billingaccounts$Locations(this.context); this.logs = new Resource$Billingaccounts$Logs(this.context); this.sinks = new Resource$Billingaccounts$Sinks(this.context); } } + export class Resource$Billingaccounts$Buckets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * logging.billingAccounts.buckets.get + * @desc Gets a bucket (Beta). + * @alias logging.billingAccounts.buckets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-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$Billingaccounts$Buckets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Billingaccounts$Buckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Billingaccounts$Buckets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Billingaccounts$Buckets$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Buckets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingaccounts$Buckets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Billingaccounts$Buckets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". + */ + name?: string; + } + export class Resource$Billingaccounts$Exclusions { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -1449,52 +1611,67 @@ export namespace logging_v2 { requestBody?: Schema$LogExclusion; } - export class Resource$Billingaccounts$Logs { + export class Resource$Billingaccounts$Locations { + context: APIRequestContext; + buckets: Resource$Billingaccounts$Locations$Buckets; + constructor(context: APIRequestContext) { + this.context = context; + this.buckets = new Resource$Billingaccounts$Locations$Buckets( + this.context + ); + } + } + + export class Resource$Billingaccounts$Locations$Buckets { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * logging.billingAccounts.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. - * @alias logging.billingAccounts.logs.delete + * logging.billingAccounts.locations.buckets.list + * @desc Lists buckets (Beta). + * @alias logging.billingAccounts.locations.buckets.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.logName Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + * @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 buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. * @param {object} [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$Billingaccounts$Logs$Delete, + list( + params?: Params$Resource$Billingaccounts$Locations$Buckets$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Billingaccounts$Logs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Billingaccounts$Locations$Buckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Billingaccounts$Logs$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Billingaccounts$Locations$Buckets$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Billingaccounts$Logs$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Billingaccounts$Locations$Buckets$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Billingaccounts$Logs$Delete; + {}) as Params$Resource$Billingaccounts$Locations$Buckets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Billingaccounts$Logs$Delete; + params = {} as Params$Resource$Billingaccounts$Locations$Buckets$List; options = {}; } @@ -1507,67 +1684,70 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+parent}/buckets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', }, options ), params, - requiredParams: ['logName'], - pathParams: ['logName'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * logging.billingAccounts.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. - * @alias logging.billingAccounts.logs.list + * logging.billingAccounts.locations.buckets.patch + * @desc Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta. + * @alias logging.billingAccounts.locations.buckets.patch * @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 resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * @param {string} params.name Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property + * @param {string=} params.updateMask Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. + * @param {().LogBucket} params.requestBody Request 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$Billingaccounts$Logs$List, + patch( + params?: Params$Resource$Billingaccounts$Locations$Buckets$Patch, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Billingaccounts$Logs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + patch( + params: Params$Resource$Billingaccounts$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Billingaccounts$Logs$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Billingaccounts$Locations$Buckets$Patch, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Billingaccounts$Logs$List - | BodyResponseCallback, + | Params$Resource$Billingaccounts$Locations$Buckets$Patch + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Billingaccounts$Logs$List; + {}) as Params$Resource$Billingaccounts$Locations$Buckets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Billingaccounts$Logs$List; + params = {} as Params$Resource$Billingaccounts$Locations$Buckets$Patch; options = {}; } @@ -1580,25 +1760,25 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Billingaccounts$Logs$Delete + export interface Params$Resource$Billingaccounts$Locations$Buckets$List extends StandardParameters { /** * Auth client or API Key for the request @@ -1606,11 +1786,19 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + * 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. */ - logName?: string; + 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 buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. + */ + parent?: string; } - export interface Params$Resource$Billingaccounts$Logs$List + export interface Params$Resource$Billingaccounts$Locations$Buckets$Patch extends StandardParameters { /** * Auth client or API Key for the request @@ -1618,55 +1806,238 @@ export namespace logging_v2 { 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. + * Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property */ - pageSize?: number; + name?: string; /** - * 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. + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. */ - pageToken?: string; + updateMask?: string; + /** - * Required. The resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Request body metadata */ - parent?: string; + requestBody?: Schema$LogBucket; } - export class Resource$Billingaccounts$Sinks { + export class Resource$Billingaccounts$Logs { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * logging.billingAccounts.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. - * @alias logging.billingAccounts.sinks.create + * logging.billingAccounts.logs.delete + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. + * @alias logging.billingAccounts.logs.delete * @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.requestBody Request body data + * @param {string} params.logName Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. * @param {object} [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$Billingaccounts$Sinks$Create, + delete( + params?: Params$Resource$Billingaccounts$Logs$Delete, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Billingaccounts$Sinks$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Billingaccounts$Logs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Billingaccounts$Sinks$Create, - callback: BodyResponseCallback + delete( + params: Params$Resource$Billingaccounts$Logs$Delete, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Billingaccounts$Logs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Logs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingaccounts$Logs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['logName'], + pathParams: ['logName'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.billingAccounts.logs.list + * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. + * @alias logging.billingAccounts.logs.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 resource name that owns the logs: "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$Billingaccounts$Logs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Billingaccounts$Logs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Billingaccounts$Logs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Billingaccounts$Logs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Billingaccounts$Logs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Billingaccounts$Logs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/logs').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$Billingaccounts$Logs$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + */ + logName?: string; + } + export interface Params$Resource$Billingaccounts$Logs$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 resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + */ + parent?: string; + } + + export class Resource$Billingaccounts$Sinks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * logging.billingAccounts.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. + * @alias logging.billingAccounts.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.requestBody Request 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$Billingaccounts$Sinks$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Billingaccounts$Sinks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Billingaccounts$Sinks$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: | Params$Resource$Billingaccounts$Sinks$Create | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, @@ -2813,11 +3184,13 @@ export namespace logging_v2 { export class Resource$Folders { context: APIRequestContext; exclusions: Resource$Folders$Exclusions; + locations: Resource$Folders$Locations; logs: Resource$Folders$Logs; sinks: Resource$Folders$Sinks; constructor(context: APIRequestContext) { this.context = context; this.exclusions = new Resource$Folders$Exclusions(this.context); + this.locations = new Resource$Folders$Locations(this.context); this.logs = new Resource$Folders$Logs(this.context); this.sinks = new Resource$Folders$Sinks(this.context); } @@ -3279,52 +3652,63 @@ export namespace logging_v2 { requestBody?: Schema$LogExclusion; } - export class Resource$Folders$Logs { + export class Resource$Folders$Locations { + context: APIRequestContext; + buckets: Resource$Folders$Locations$Buckets; + constructor(context: APIRequestContext) { + this.context = context; + this.buckets = new Resource$Folders$Locations$Buckets(this.context); + } + } + + export class Resource$Folders$Locations$Buckets { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * logging.folders.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. - * @alias logging.folders.logs.delete + * logging.folders.locations.buckets.get + * @desc Gets a bucket (Beta). + * @alias logging.folders.locations.buckets.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.logName Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + * @param {string} params.name Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-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$Folders$Logs$Delete, + get( + params?: Params$Resource$Folders$Locations$Buckets$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Folders$Logs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Folders$Locations$Buckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Folders$Logs$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Folders$Locations$Buckets$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Folders$Logs$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Folders$Locations$Buckets$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Logs$Delete; + {}) as Params$Resource$Folders$Locations$Buckets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Logs$Delete; + params = {} as Params$Resource$Folders$Locations$Buckets$Get; options = {}; } @@ -3337,67 +3721,67 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['logName'], - pathParams: ['logName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * logging.folders.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. - * @alias logging.folders.logs.list + * logging.folders.locations.buckets.list + * @desc Lists buckets (Beta). + * @alias logging.folders.locations.buckets.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 resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * @param {string} params.parent Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. * @param {object} [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$Logs$List, + params?: Params$Resource$Folders$Locations$Buckets$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Folders$Logs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Buckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Folders$Logs$List, - callback: BodyResponseCallback + params: Params$Resource$Folders$Locations$Buckets$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Folders$Logs$List - | BodyResponseCallback, + | Params$Resource$Folders$Locations$Buckets$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Logs$List; + {}) as Params$Resource$Folders$Locations$Buckets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Logs$List; + params = {} as Params$Resource$Folders$Locations$Buckets$List; options = {}; } @@ -3410,7 +3794,286 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+parent}/buckets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.folders.locations.buckets.patch + * @desc Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta. + * @alias logging.folders.locations.buckets.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property + * @param {string=} params.updateMask Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. + * @param {().LogBucket} params.requestBody Request 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$Folders$Locations$Buckets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Folders$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Folders$Locations$Buckets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Folders$Locations$Buckets$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Locations$Buckets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Locations$Buckets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Locations$Buckets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". + */ + name?: string; + } + export interface Params$Resource$Folders$Locations$Buckets$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 buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. + */ + parent?: string; + } + export interface Params$Resource$Folders$Locations$Buckets$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property + */ + name?: string; + /** + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + + export class Resource$Folders$Logs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * logging.folders.logs.delete + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. + * @alias logging.folders.logs.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.logName Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + * @param {object} [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$Folders$Logs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Folders$Logs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Folders$Logs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Folders$Logs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Logs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Logs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['logName'], + pathParams: ['logName'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.folders.logs.list + * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. + * @alias logging.folders.logs.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 resource name that owns the logs: "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$Folders$Logs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Folders$Logs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Folders$Logs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Folders$Logs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Folders$Logs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Folders$Logs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -4016,26 +4679,316 @@ export namespace logging_v2 { requestBody?: Schema$LogSink; } - export class Resource$Logs { + export class Resource$Locations { + context: APIRequestContext; + buckets: Resource$Locations$Buckets; + constructor(context: APIRequestContext) { + this.context = context; + this.buckets = new Resource$Locations$Buckets(this.context); + } + } + + export class Resource$Locations$Buckets { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * logging.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. - * @alias logging.logs.delete + * logging.locations.buckets.get + * @desc Gets a bucket (Beta). + * @alias logging.locations.buckets.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.logName Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + * @param {string} params.name Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-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$Logs$Delete, + get( + params?: Params$Resource$Locations$Buckets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Locations$Buckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Locations$Buckets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Locations$Buckets$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Locations$Buckets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Locations$Buckets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.locations.buckets.list + * @desc Lists buckets (Beta). + * @alias logging.locations.buckets.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 buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. + * @param {object} [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$Locations$Buckets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Locations$Buckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Locations$Buckets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Locations$Buckets$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Locations$Buckets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Locations$Buckets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/buckets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.locations.buckets.patch + * @desc Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta. + * @alias logging.locations.buckets.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property + * @param {string=} params.updateMask Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. + * @param {().LogBucket} params.requestBody Request 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$Locations$Buckets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Locations$Buckets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Locations$Buckets$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Locations$Buckets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Locations$Buckets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Locations$Buckets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". + */ + name?: string; + } + export interface Params$Resource$Locations$Buckets$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 buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. + */ + parent?: string; + } + export interface Params$Resource$Locations$Buckets$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property + */ + name?: string; + /** + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + + export class Resource$Logs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * logging.logs.delete + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. + * @alias logging.logs.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.logName Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + * @param {object} [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$Logs$Delete, options?: MethodOptions ): GaxiosPromise; delete( @@ -4313,65 +5266,59 @@ export namespace logging_v2 { export class Resource$Organizations { context: APIRequestContext; exclusions: Resource$Organizations$Exclusions; + locations: Resource$Organizations$Locations; logs: Resource$Organizations$Logs; sinks: Resource$Organizations$Sinks; constructor(context: APIRequestContext) { this.context = context; this.exclusions = new Resource$Organizations$Exclusions(this.context); + this.locations = new Resource$Organizations$Locations(this.context); this.logs = new Resource$Organizations$Logs(this.context); this.sinks = new Resource$Organizations$Sinks(this.context); } - } - - export class Resource$Organizations$Exclusions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * logging.organizations.exclusions.create - * @desc Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. - * @alias logging.organizations.exclusions.create + * logging.organizations.getCmekSettings + * @desc Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information. + * @alias logging.organizations.getCmekSettings * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - * @param {().LogExclusion} params.requestBody Request body data + * @param {string} params.name Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. * @param {object} [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$Organizations$Exclusions$Create, + getCmekSettings( + params?: Params$Resource$Organizations$Getcmeksettings, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Organizations$Exclusions$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Organizations$Exclusions$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( + ): GaxiosPromise; + getCmekSettings( + params: Params$Resource$Organizations$Getcmeksettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekSettings( + params: Params$Resource$Organizations$Getcmeksettings, + callback: BodyResponseCallback + ): void; + getCmekSettings(callback: BodyResponseCallback): void; + getCmekSettings( paramsOrCallback?: - | Params$Resource$Organizations$Exclusions$Create - | BodyResponseCallback, + | Params$Resource$Organizations$Getcmeksettings + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Exclusions$Create; + {}) as Params$Resource$Organizations$Getcmeksettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Exclusions$Create; + params = {} as Params$Resource$Organizations$Getcmeksettings; options = {}; } @@ -4384,28 +5331,222 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/exclusions').replace( + url: (rootUrl + '/v2/{+name}/cmekSettings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * logging.organizations.exclusions.delete + * logging.organizations.updateCmekSettings + * @desc Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router for more information. + * @alias logging.organizations.updateCmekSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. + * @param {string=} params.updateMask Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.Example: "updateMask=kmsKeyName" + * @param {().CmekSettings} params.requestBody Request 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 + */ + updateCmekSettings( + params?: Params$Resource$Organizations$Updatecmeksettings, + options?: MethodOptions + ): GaxiosPromise; + updateCmekSettings( + params: Params$Resource$Organizations$Updatecmeksettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekSettings( + params: Params$Resource$Organizations$Updatecmeksettings, + callback: BodyResponseCallback + ): void; + updateCmekSettings( + callback: BodyResponseCallback + ): void; + updateCmekSettings( + paramsOrCallback?: + | Params$Resource$Organizations$Updatecmeksettings + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Updatecmeksettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Updatecmeksettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/cmekSettings').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$Getcmeksettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. + */ + name?: string; + } + export interface Params$Resource$Organizations$Updatecmeksettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. + */ + name?: string; + /** + * Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.Example: "updateMask=kmsKeyName" + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CmekSettings; + } + + export class Resource$Organizations$Exclusions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * logging.organizations.exclusions.create + * @desc Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. + * @alias logging.organizations.exclusions.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". + * @param {().LogExclusion} params.requestBody Request 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$Organizations$Exclusions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Exclusions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Exclusions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Exclusions$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Exclusions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Exclusions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/exclusions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.organizations.exclusions.delete * @desc Deletes an exclusion. * @alias logging.organizations.exclusions.delete * @memberOf! () @@ -4779,52 +5920,63 @@ export namespace logging_v2 { requestBody?: Schema$LogExclusion; } - export class Resource$Organizations$Logs { + export class Resource$Organizations$Locations { + context: APIRequestContext; + buckets: Resource$Organizations$Locations$Buckets; + constructor(context: APIRequestContext) { + this.context = context; + this.buckets = new Resource$Organizations$Locations$Buckets(this.context); + } + } + + export class Resource$Organizations$Locations$Buckets { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * logging.organizations.logs.delete - * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. - * @alias logging.organizations.logs.delete + * logging.organizations.locations.buckets.get + * @desc Gets a bucket (Beta). + * @alias logging.organizations.locations.buckets.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.logName Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + * @param {string} params.name Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-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$Organizations$Logs$Delete, + get( + params?: Params$Resource$Organizations$Locations$Buckets$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Logs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Locations$Buckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Organizations$Logs$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Organizations$Locations$Buckets$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Organizations$Logs$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Organizations$Locations$Buckets$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Logs$Delete; + {}) as Params$Resource$Organizations$Locations$Buckets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Logs$Delete; + params = {} as Params$Resource$Organizations$Locations$Buckets$Get; options = {}; } @@ -4837,67 +5989,67 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['logName'], - pathParams: ['logName'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * logging.organizations.logs.list - * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. - * @alias logging.organizations.logs.list + * logging.organizations.locations.buckets.list + * @desc Lists buckets (Beta). + * @alias logging.organizations.locations.buckets.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 resource name that owns the logs: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * @param {string} params.parent Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. * @param {object} [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$Logs$List, + params?: Params$Resource$Organizations$Locations$Buckets$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Organizations$Logs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Organizations$Logs$List, - callback: BodyResponseCallback + params: Params$Resource$Organizations$Locations$Buckets$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Organizations$Logs$List - | BodyResponseCallback, + | Params$Resource$Organizations$Locations$Buckets$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Logs$List; + {}) as Params$Resource$Organizations$Locations$Buckets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Logs$List; + params = {} as Params$Resource$Organizations$Locations$Buckets$List; options = {}; } @@ -4910,7 +6062,10 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/logs').replace(/([^:]\/)\/+/g, '$1'), + url: (rootUrl + '/v2/{+parent}/buckets').replace( + /([^:]\/)\/+/g, + '$1' + ), method: 'GET', }, options @@ -4921,22 +6076,298 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - export interface Params$Resource$Organizations$Logs$Delete - extends StandardParameters { /** - * Auth client or API Key for the request + * logging.organizations.locations.buckets.patch + * @desc Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta. + * @alias logging.organizations.locations.buckets.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property + * @param {string=} params.updateMask Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. + * @param {().LogBucket} params.requestBody Request 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 */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + patch( + params?: Params$Resource$Organizations$Locations$Buckets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Locations$Buckets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizations$Locations$Buckets$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Locations$Buckets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; - /** - * Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Locations$Buckets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Locations$Buckets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". + */ + name?: string; + } + export interface Params$Resource$Organizations$Locations$Buckets$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 buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. + */ + parent?: string; + } + export interface Params$Resource$Organizations$Locations$Buckets$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property + */ + name?: string; + /** + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogBucket; + } + + export class Resource$Organizations$Logs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * logging.organizations.logs.delete + * @desc Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted. Entries received after the delete operation with a timestamp before the operation will be deleted. + * @alias logging.organizations.logs.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.logName Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Organizations$Logs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Logs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Logs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Logs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Logs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Logs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+logName}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['logName'], + pathParams: ['logName'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.organizations.logs.list + * @desc Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed. + * @alias logging.organizations.logs.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 resource name that owns the logs: "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$Organizations$Logs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Logs$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Logs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Logs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Logs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Logs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/logs').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$Logs$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the log to delete: "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". For more information about log names, see LogEntry. */ logName?: string; } @@ -5519,12 +6950,14 @@ export namespace logging_v2 { export class Resource$Projects { context: APIRequestContext; exclusions: Resource$Projects$Exclusions; + locations: Resource$Projects$Locations; logs: Resource$Projects$Logs; metrics: Resource$Projects$Metrics; sinks: Resource$Projects$Sinks; constructor(context: APIRequestContext) { this.context = context; this.exclusions = new Resource$Projects$Exclusions(this.context); + this.locations = new Resource$Projects$Locations(this.context); this.logs = new Resource$Projects$Logs(this.context); this.metrics = new Resource$Projects$Metrics(this.context); this.sinks = new Resource$Projects$Sinks(this.context); @@ -5660,69 +7093,390 @@ export namespace logging_v2 { options = {}; } - const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.projects.exclusions.get + * @desc Gets the description of an exclusion. + * @alias logging.projects.exclusions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-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$Exclusions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Exclusions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Exclusions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Exclusions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Exclusions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Exclusions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.projects.exclusions.list + * @desc Lists all the exclusions in a parent resource. + * @alias logging.projects.exclusions.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 exclusions 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$Exclusions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Exclusions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Exclusions$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Exclusions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Exclusions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Exclusions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+parent}/exclusions').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.exclusions.patch + * @desc Changes one or more properties of an existing exclusion. + * @alias logging.projects.exclusions.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". + * @param {string=} params.updateMask Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * @param {().LogExclusion} params.requestBody Request 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$Exclusions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Exclusions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Exclusions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Exclusions$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Exclusions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Exclusions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+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$Exclusions$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogExclusion; + } + export interface Params$Resource$Projects$Exclusions$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". + */ + name?: string; + } + export interface Params$Resource$Projects$Exclusions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". + */ + name?: string; + } + export interface Params$Resource$Projects$Exclusions$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 exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + */ + parent?: string; + } + export interface Params$Resource$Projects$Exclusions$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". + */ + name?: string; + /** + * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LogExclusion; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + buckets: Resource$Projects$Locations$Buckets; + constructor(context: APIRequestContext) { + this.context = context; + this.buckets = new Resource$Projects$Locations$Buckets(this.context); + } + } + + export class Resource$Projects$Locations$Buckets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * logging.projects.exclusions.get - * @desc Gets the description of an exclusion. - * @alias logging.projects.exclusions.get + * logging.projects.locations.buckets.get + * @desc Gets a bucket (Beta). + * @alias logging.projects.locations.buckets.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". + * @param {string} params.name Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-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$Exclusions$Get, + params?: Params$Resource$Projects$Locations$Buckets$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Exclusions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Exclusions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Exclusions$Get - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Buckets$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Exclusions$Get; + {}) as Params$Resource$Projects$Locations$Buckets$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Exclusions$Get; + params = {} as Params$Resource$Projects$Locations$Buckets$Get; options = {}; } @@ -5746,58 +7500,56 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * logging.projects.exclusions.list - * @desc Lists all the exclusions in a parent resource. - * @alias logging.projects.exclusions.list + * logging.projects.locations.buckets.list + * @desc Lists buckets (Beta). + * @alias logging.projects.locations.buckets.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 exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * @param {string} params.parent Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. * @param {object} [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$Exclusions$List, + params?: Params$Resource$Projects$Locations$Buckets$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Exclusions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Exclusions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Exclusions$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Buckets$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Exclusions$List; + {}) as Params$Resource$Projects$Locations$Buckets$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Exclusions$List; + params = {} as Params$Resource$Projects$Locations$Buckets$List; options = {}; } @@ -5810,7 +7562,7 @@ export namespace logging_v2 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v2/{+parent}/exclusions').replace( + url: (rootUrl + '/v2/{+parent}/buckets').replace( /([^:]\/)\/+/g, '$1' ), @@ -5824,56 +7576,56 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * logging.projects.exclusions.patch - * @desc Changes one or more properties of an existing exclusion. - * @alias logging.projects.exclusions.patch + * logging.projects.locations.buckets.patch + * @desc Updates a bucket. This method replaces the following fields in the existing bucket with values from the new bucket: retention_periodIf the retention period is decreased and the bucket is locked, FAILED_PRECONDITION will be returned.If the bucket has a LifecycleState of DELETE_REQUESTED, FAILED_PRECONDITION will be returned.A buckets region may not be modified after it is created. This method is in Beta. + * @alias logging.projects.locations.buckets.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". - * @param {string=} params.updateMask Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". - * @param {().LogExclusion} params.requestBody Request body data + * @param {string} params.name Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property + * @param {string=} params.updateMask Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. + * @param {().LogBucket} params.requestBody Request 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$Exclusions$Patch, + params?: Params$Resource$Projects$Locations$Buckets$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Projects$Exclusions$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Projects$Exclusions$Patch, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Buckets$Patch, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; + patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: - | Params$Resource$Projects$Exclusions$Patch - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Buckets$Patch + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Exclusions$Patch; + {}) as Params$Resource$Projects$Locations$Buckets$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Exclusions$Patch; + params = {} as Params$Resource$Projects$Locations$Buckets$Patch; options = {}; } @@ -5897,43 +7649,14 @@ export namespace logging_v2 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Exclusions$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" Examples: "projects/my-logging-project", "organizations/123456789". - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$LogExclusion; - } - export interface Params$Resource$Projects$Exclusions$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". - */ - name?: string; - } - export interface Params$Resource$Projects$Exclusions$Get + export interface Params$Resource$Projects$Locations$Buckets$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -5941,11 +7664,11 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". */ name?: string; } - export interface Params$Resource$Projects$Exclusions$List + export interface Params$Resource$Projects$Locations$Buckets$List extends StandardParameters { /** * Auth client or API Key for the request @@ -5961,11 +7684,11 @@ export namespace logging_v2 { */ pageToken?: string; /** - * Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" + * Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource is required, but supplying the character - in place of LOCATION_ID will return all buckets. */ parent?: string; } - export interface Params$Resource$Projects$Exclusions$Patch + export interface Params$Resource$Projects$Locations$Buckets$Patch extends StandardParameters { /** * Auth client or API Key for the request @@ -5973,18 +7696,18 @@ export namespace logging_v2 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" Example: "projects/my-project-id/exclusions/my-exclusion-id". + * Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" Example: "projects/my-project-id/locations/my-location/buckets/my-bucket-id". Also requires permission "resourcemanager.projects.updateLiens" to set the locked property */ name?: string; /** - * Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". + * Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskExample: updateMask=retention_days. */ updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$LogExclusion; + requestBody?: Schema$LogBucket; } export class Resource$Projects$Logs { @@ -7622,4 +9345,197 @@ export namespace logging_v2 { */ requestBody?: Schema$LogSink; } + + export class Resource$V2 { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * logging.getCmekSettings + * @desc Gets the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.See Enabling CMEK for Logs Router for more information. + * @alias logging.getCmekSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getCmekSettings( + params?: Params$Resource$V2$Getcmeksettings, + options?: MethodOptions + ): GaxiosPromise; + getCmekSettings( + params: Params$Resource$V2$Getcmeksettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekSettings( + params: Params$Resource$V2$Getcmeksettings, + callback: BodyResponseCallback + ): void; + getCmekSettings(callback: BodyResponseCallback): void; + getCmekSettings( + paramsOrCallback?: + | Params$Resource$V2$Getcmeksettings + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$V2$Getcmeksettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$V2$Getcmeksettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/cmekSettings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * logging.updateCmekSettings + * @desc Updates the Logs Router CMEK settings for the given resource.Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Logs Router for more information. + * @alias logging.updateCmekSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. + * @param {string=} params.updateMask Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.Example: "updateMask=kmsKeyName" + * @param {().CmekSettings} params.requestBody Request 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 + */ + updateCmekSettings( + params?: Params$Resource$V2$Updatecmeksettings, + options?: MethodOptions + ): GaxiosPromise; + updateCmekSettings( + params: Params$Resource$V2$Updatecmeksettings, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekSettings( + params: Params$Resource$V2$Updatecmeksettings, + callback: BodyResponseCallback + ): void; + updateCmekSettings( + callback: BodyResponseCallback + ): void; + updateCmekSettings( + paramsOrCallback?: + | Params$Resource$V2$Updatecmeksettings + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$V2$Updatecmeksettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$V2$Updatecmeksettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://logging.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2/{+name}/cmekSettings').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$V2$Getcmeksettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. + */ + name?: string; + } + export interface Params$Resource$V2$Updatecmeksettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" Example: "organizations/12345/cmekSettings".Note: CMEK for the Logs Router can currently only be configured for GCP organizations. Once configured, it applies to all projects and folders in the GCP organization. + */ + name?: string; + /** + * Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.Example: "updateMask=kmsKeyName" + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CmekSettings; + } } diff --git a/src/apis/ml/v1.ts b/src/apis/ml/v1.ts index 1719cdb99d..6e1a7915f2 100644 --- a/src/apis/ml/v1.ts +++ b/src/apis/ml/v1.ts @@ -660,7 +660,7 @@ export namespace ml_v1 { */ export interface Schema$GoogleCloudMlV1__RequestLoggingConfig { /** - * Required. Fully qualified BigQuery table name in the following format: "<var>project_id</var>.<var>dataset_name</var>.<var>table_name</var>" The specifcied table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): <table> <tr><th>Field name</th><th style="display: table-cell">Type</th> <th style="display: table-cell">Mode</th></tr> <tr><td>model</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>model_version</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>time</td><td>TIMESTAMP</td><td>REQUIRED</td></tr> <tr><td>raw_data</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>raw_prediction</td><td>STRING</td><td>NULLABLE</td></tr> <tr><td>groundtruth</td><td>STRING</td><td>NULLABLE</td></tr> </table> + * Required. Fully qualified BigQuery table name in the following format: "<var>project_id</var>.<var>dataset_name</var>.<var>table_name</var>" The specified table must already exist, and the "Cloud ML Service Agent" for your project must have permission to write to it. The table must have the following [schema](/bigquery/docs/schemas): <table> <tr><th>Field name</th><th style="display: table-cell">Type</th> <th style="display: table-cell">Mode</th></tr> <tr><td>model</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>model_version</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>time</td><td>TIMESTAMP</td><td>REQUIRED</td></tr> <tr><td>raw_data</td><td>STRING</td><td>REQUIRED</td></tr> <tr><td>raw_prediction</td><td>STRING</td><td>NULLABLE</td></tr> <tr><td>groundtruth</td><td>STRING</td><td>NULLABLE</td></tr> </table> */ bigqueryTableName?: string | null; /** @@ -677,12 +677,21 @@ export namespace ml_v1 { */ numPaths?: number | null; } + /** + * All parameters related to scheduling of training jobs. + */ + export interface Schema$GoogleCloudMlV1__Scheduling { + /** + * Optional. The maximum job running time, expressed in seconds. The field can contain up to nine fractional digits, terminated by `s`. By default there is no limit to the running time. If the training job is still running after this duration, AI Platform Training cancels it. For example, if you want to ensure your job runs for no more than 2 hours, set this field to `7200s` (2 hours * 60 minutes / hour * 60 seconds / minute). If you submit your training job using the `gcloud` tool, you can [provide this field in a `config.yaml` file](/ai-platform/training/docs/training-jobs#formatting_your_configuration_parameters). For example: ```yaml trainingInput: ... scheduling: maxRunningTime: 7200s ... ``` + */ + maxRunningTime?: string | null; + } /** * Request message for the SetDefaultVersion request. */ export interface Schema$GoogleCloudMlV1__SetDefaultVersionRequest {} /** - * Represents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to <a href="/ml-engine/docs/tensorflow/training-jobs">submitting a training job</a>. + * Represents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to [submitting a training job](/ai-platform/training/docs/training-jobs). */ export interface Schema$GoogleCloudMlV1__TrainingInput { /** @@ -726,21 +735,25 @@ export namespace ml_v1 { */ pythonModule?: string | null; /** - * Optional. The version of Python used in training. If not set, the default version is '2.7'. Starting [January 13, 2020](/ml-engine/docs/release-notes#december_10_2019), this field is required. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. (Runtime versions released [after January 1, 2020](/ml-engine/docs/release-notes#december_10_2019) do not support Python 2.7.) Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). + * Optional. The version of Python used in training. You must either specify this field or specify `masterConfig.imageUri`. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). */ pythonVersion?: string | null; /** - * Required. The Google Compute Engine region to run the training job in. See the <a href="/ml-engine/docs/tensorflow/regions">available regions</a> for AI Platform services. + * Required. The region to run the training job in. See the [available regions](/ai-platform/training/docs/regions) for AI Platform Training. */ region?: string | null; /** - * Optional. The AI Platform runtime version to use for training. If not set, AI Platform uses the default stable version, 1.0. Starting [January 13, 2020](/ml-engine/docs/release-notes#december_10_2019), this field is required. For more information, see the <a href="/ml-engine/docs/runtime-version-list">runtime version list</a> and <a href="/ml-engine/docs/versioning">how to manage runtime versions</a>. + * Optional. The AI Platform runtime version to use for training. You must either specify this field or specify `masterConfig.imageUri`. For more information, see the [runtime version list](/ai-platform/training/docs/runtime-version-list) and learn [how to manage runtime versions](/ai-platform/training/docs/versioning). */ runtimeVersion?: string | null; /** * Required. Specifies the machine types, the number of replicas for workers and parameter servers. */ scaleTier?: string | null; + /** + * Optional. Scheduling options for a training job. + */ + scheduling?: Schema$GoogleCloudMlV1__Scheduling; /** * Optional. Use 'chief' instead of 'master' in TF_CONFIG when Custom Container is used and evaluator is not specified. Defaults to false. */ @@ -864,7 +877,7 @@ export namespace ml_v1 { */ predictionClass?: string | null; /** - * Optional. The version of Python used in prediction. If not set, the default version is '2.7'. Starting [January 13, 2020](/ml-engine/docs/release-notes#december_10_2019), this field is required. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. (Runtime versions released [after January 1, 2020](/ml-engine/docs/release-notes#december_10_2019) do not support Python 2.7.) Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). + * Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). */ pythonVersion?: string | null; /** @@ -872,7 +885,7 @@ export namespace ml_v1 { */ requestLoggingConfig?: Schema$GoogleCloudMlV1__RequestLoggingConfig; /** - * Optional. The AI Platform runtime version to use for this deployment. If not set, AI Platform uses the default stable version, 1.0. Starting [January 13, 2020](/ml-engine/docs/release-notes#december_10_2019), this field is required. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). + * Required. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). */ runtimeVersion?: string | null; /** @@ -1039,23 +1052,23 @@ export namespace ml_v1 { message?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$GoogleType__Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/monitoring/v1.ts b/src/apis/monitoring/v1.ts index 56960d38ea..edf3b9e209 100644 --- a/src/apis/monitoring/v1.ts +++ b/src/apis/monitoring/v1.ts @@ -116,23 +116,23 @@ export namespace monitoring_v1 { } /** - * Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (alignment_period and per_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer and group_by_fields). For more details, see Aggregation. + * Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Aggregating Time Series. */ export interface Schema$Aggregation { /** - * The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. + * The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored. */ alignmentPeriod?: string | null; /** - * The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + * The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. */ crossSeriesReducer?: string | null; /** - * The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. + * The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. */ groupByFields?: string[] | null; /** - * The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + * An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. */ perSeriesAligner?: string | null; } @@ -323,7 +323,7 @@ export namespace monitoring_v1 { */ dashboards?: Schema$Dashboard[]; /** - * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; } @@ -341,7 +341,7 @@ export namespace monitoring_v1 { value?: {[key: string]: any} | null; } /** - * Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter lets through up to num_time_series time series, selecting them based on the relative ranking. + * Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. */ export interface Schema$PickTimeSeriesFilter { /** @@ -349,11 +349,11 @@ export namespace monitoring_v1 { */ direction?: string | null; /** - * How many time series to return. + * How many time series to allow to pass through the filter. */ numTimeSeries?: number | null; /** - * rankingMethod is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + * ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. */ rankingMethod?: string | null; } @@ -423,11 +423,11 @@ export namespace monitoring_v1 { fileName?: string | null; } /** - * The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.It contains the name of a span with format: projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID + * The context of a span, attached to Exemplars in Distribution values during aggregation.It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] */ export interface Schema$SpanContext { /** - * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] TRACE_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.SPAN_ID is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. + * The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. */ spanName?: string | null; } @@ -444,19 +444,6 @@ export namespace monitoring_v1 { */ sparkChartType?: string | null; } - /** - * A filter that ranks streams based on their statistical relation to other streams in a request. - */ - export interface Schema$StatisticalTimeSeriesFilter { - /** - * How many time series to output. - */ - numTimeSeries?: number | null; - /** - * rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. - */ - rankingMethod?: string | null; - } /** * A widget that displays textual content. */ @@ -507,10 +494,6 @@ export namespace monitoring_v1 { * Ranking based time series filter. */ pickTimeSeriesFilter?: Schema$PickTimeSeriesFilter; - /** - * Statistics based time series filter. - */ - statisticalTimeSeriesFilter?: Schema$StatisticalTimeSeriesFilter; } /** * A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. @@ -532,10 +515,6 @@ export namespace monitoring_v1 { * Apply a second aggregation after the ratio is computed. */ secondaryAggregation?: Schema$Aggregation; - /** - * Statistics based time series filter. - */ - statisticalTimeSeriesFilter?: Schema$StatisticalTimeSeriesFilter; } /** * TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. @@ -660,7 +639,7 @@ export namespace monitoring_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Required. The project on which to execute the request. The format is "projects/{project_id_or_number}". The {project_id_or_number} must match the dashboard resource name. + * @param {string} params.parent Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name. * @param {().Dashboard} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -735,7 +714,7 @@ export namespace monitoring_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the Dashboard. The format is "projects/{project_id_or_number}/dashboards/{dashboard_id}". + * @param {string} params.name Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_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 @@ -804,7 +783,7 @@ export namespace monitoring_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required. The resource name of the Dashboard. The format is one of "dashboards/{dashboard_id}" (for system dashboards) or "projects/{project_id_or_number}/dashboards/{dashboard_id}" (for custom dashboards). + * @param {string} params.name Required. The resource name of the Dashboard. The format is one of: dashboards/[DASHBOARD_ID] (for system dashboards) projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] (for custom dashboards). * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -877,7 +856,7 @@ export namespace monitoring_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - * @param {string} params.parent Required. The scope of the dashboards to list. A project scope must be specified in the form of "projects/{project_id_or_number}". + * @param {string} params.parent Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1027,7 +1006,7 @@ export namespace monitoring_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The project on which to execute the request. The format is "projects/{project_id_or_number}". The {project_id_or_number} must match the dashboard resource name. + * Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name. */ parent?: string; @@ -1044,7 +1023,7 @@ export namespace monitoring_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the Dashboard. The format is "projects/{project_id_or_number}/dashboards/{dashboard_id}". + * Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] */ name?: string; } @@ -1056,7 +1035,7 @@ export namespace monitoring_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. The resource name of the Dashboard. The format is one of "dashboards/{dashboard_id}" (for system dashboards) or "projects/{project_id_or_number}/dashboards/{dashboard_id}" (for custom dashboards). + * Required. The resource name of the Dashboard. The format is one of: dashboards/[DASHBOARD_ID] (for system dashboards) projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] (for custom dashboards). */ name?: string; } @@ -1076,7 +1055,7 @@ export namespace monitoring_v1 { */ pageToken?: string; /** - * Required. The scope of the dashboards to list. A project scope must be specified in the form of "projects/{project_id_or_number}". + * Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER] */ parent?: string; } diff --git a/src/apis/monitoring/v3.ts b/src/apis/monitoring/v3.ts index 3c448f3e76..73d6be6519 100644 --- a/src/apis/monitoring/v3.ts +++ b/src/apis/monitoring/v3.ts @@ -120,23 +120,23 @@ export namespace monitoring_v3 { } /** - * Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (alignment_period and per_series_aligner) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer and group_by_fields). For more details, see Aggregation. + * Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Aggregating Time Series. */ export interface Schema$Aggregation { /** - * The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. + * The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored. */ alignmentPeriod?: string | null; /** - * The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + * The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. */ crossSeriesReducer?: string | null; /** - * The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. + * The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. */ groupByFields?: string[] | null; /** - * The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + * An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. */ perSeriesAligner?: string | null; } @@ -149,7 +149,7 @@ export namespace monitoring_v3 { */ combiner?: string | null; /** - * A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If |condition_time_series_uery_language| is present, it must be the only |condition|. + * A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. */ conditions?: Schema$Condition[]; /** @@ -173,11 +173,11 @@ export namespace monitoring_v3 { */ mutationRecord?: Schema$MutationRecord; /** - * Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. + * Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. */ name?: string | null; /** - * Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The syntax of the entries in this field is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] + * Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] */ notificationChannels?: string[] | null; /** @@ -267,7 +267,7 @@ export namespace monitoring_v3 { service?: string | null; } /** - * Istio service. Learn more at http://istio.io. + * Istio service scoped to a single Kubernetes cluster. Learn more at http://istio.io. */ export interface Schema$ClusterIstio { /** @@ -388,7 +388,7 @@ export namespace monitoring_v3 { */ displayName?: string | null; /** - * Required if the condition exists. The unique resource name for this condition. Its syntax is: projects/[PROJECT_ID]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Stackdriver Monitoring creates the condition identifiers and includes them in the new policy.When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted. + * Required if the condition exists. The unique resource name for this condition. Its format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID] [CONDITION_ID] is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy.When calling the alertPolicies.create method, do not include the name field in the conditions of the requested alerting policy. Stackdriver Monitoring creates the condition identifiers and includes them in the new policy.When calling the alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated.Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted. */ name?: string | null; } @@ -440,7 +440,7 @@ export namespace monitoring_v3 { */ export interface Schema$CreateTimeSeriesRequest { /** - * The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.The maximum number of TimeSeries objects per Create request is 200. + * Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.The maximum number of TimeSeries objects per Create request is 200. */ timeSeries?: Schema$TimeSeries[]; } @@ -690,11 +690,11 @@ export namespace monitoring_v3 { */ isCluster?: boolean | null; /** - * Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically. + * Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically. */ name?: string | null; /** - * The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "". + * The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "". */ parentName?: string | null; } @@ -744,7 +744,7 @@ export namespace monitoring_v3 { */ gcpZone?: string | null; /** - * A unique resource name for this InternalChecker. The format is:projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKER_ID].[PROJECT_ID] is the Stackdriver Workspace project for the Uptime check config associated with the internal checker. + * A unique resource name for this InternalChecker. The format is: projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID] [PROJECT_ID_OR_NUMBER] is the Stackdriver Workspace project for the Uptime check config associated with the internal checker. */ name?: string | null; /** @@ -812,7 +812,7 @@ export namespace monitoring_v3 { */ alertPolicies?: Schema$AlertPolicy[]; /** - * If there might be more results than were returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there might be more results than were returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; } @@ -825,7 +825,7 @@ export namespace monitoring_v3 { */ members?: Schema$MonitoredResource[]; /** - * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; /** @@ -842,7 +842,7 @@ export namespace monitoring_v3 { */ group?: Schema$Group[]; /** - * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; } @@ -855,7 +855,7 @@ export namespace monitoring_v3 { */ metricDescriptors?: Schema$MetricDescriptor[]; /** - * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; } @@ -864,7 +864,7 @@ export namespace monitoring_v3 { */ export interface Schema$ListMonitoredResourceDescriptorsResponse { /** - * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; /** @@ -903,7 +903,7 @@ export namespace monitoring_v3 { */ export interface Schema$ListServiceLevelObjectivesResponse { /** - * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; /** @@ -916,7 +916,7 @@ export namespace monitoring_v3 { */ export interface Schema$ListServicesResponse { /** - * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; /** @@ -933,7 +933,7 @@ export namespace monitoring_v3 { */ executionErrors?: Schema$Status[]; /** - * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method. + * If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. */ nextPageToken?: string | null; /** @@ -971,6 +971,23 @@ export namespace monitoring_v3 { */ uptimeCheckIps?: Schema$UptimeCheckIp[]; } + /** + * Istio service scoped to an Istio mesh + */ + export interface Schema$MeshIstio { + /** + * Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics. + */ + meshUid?: string | null; + /** + * The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. + */ + serviceName?: string | null; + /** + * The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. + */ + serviceNamespace?: string | null; + } /** * A specific metric, identified by specifying values for all of the labels of a MetricDescriptor. */ @@ -997,7 +1014,7 @@ export namespace monitoring_v3 { */ duration?: string | null; /** - * A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. + * A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ filter?: string | null; /** @@ -1101,7 +1118,7 @@ export namespace monitoring_v3 { */ denominatorAggregations?: Schema$Aggregation[]; /** - * A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. + * A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ denominatorFilter?: string | null; /** @@ -1109,7 +1126,7 @@ export namespace monitoring_v3 { */ duration?: string | null; /** - * A filter that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. + * A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that is specified in the ListTimeSeries request (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length. */ filter?: string | null; /** @@ -1210,7 +1227,7 @@ export namespace monitoring_v3 { */ labels?: {[key: string]: string} | null; /** - * The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. + * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ name?: string | null; /** @@ -1243,7 +1260,11 @@ export namespace monitoring_v3 { */ labels?: Schema$LabelDescriptor[]; /** - * The full REST resource name for this descriptor. The syntax is: projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field. + * The product launch stage for channels of this type. + */ + launchStage?: string | null; + /** + * The full REST resource name for this descriptor. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field. */ name?: string | null; /** @@ -1325,7 +1346,7 @@ export namespace monitoring_v3 { */ export interface Schema$ResourceGroup { /** - * The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID]/groups/[GROUP_ID]. + * The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]. */ groupId?: string | null; /** @@ -1362,7 +1383,11 @@ export namespace monitoring_v3 { */ displayName?: string | null; /** - * Resource name for this Service. Of the form projects/{project_id}/services/{service_id}. + * Type used for Istio services scoped to an Istio mesh. + */ + meshIstio?: Schema$MeshIstio; + /** + * Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID} */ name?: string | null; /** @@ -1404,7 +1429,7 @@ export namespace monitoring_v3 { */ goal?: number | null; /** - * Resource name for this ServiceLevelObjective. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}. + * Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */ name?: string | null; /** @@ -1426,11 +1451,11 @@ export namespace monitoring_v3 { fileName?: string | null; } /** - * The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.It contains the name of a span with format: projects/PROJECT_ID/traces/TRACE_ID/spans/SPAN_ID + * The context of a span, attached to Exemplars in Distribution values during aggregation.It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] */ export interface Schema$SpanContext { /** - * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] TRACE_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.SPAN_ID is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. + * The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. */ spanName?: string | null; } @@ -1624,7 +1649,7 @@ export namespace monitoring_v3 { */ monitoredResource?: Schema$MonitoredResource; /** - * A unique resource name for this Uptime check configuration. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. + * A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. */ name?: string | null; /** @@ -1670,7 +1695,7 @@ export namespace monitoring_v3 { */ export interface Schema$VerifyNotificationChannelRequest { /** - * The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code). + * Required. The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code). */ code?: string | null; } @@ -1750,7 +1775,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project in which to create the alerting policy. The format is projects/[PROJECT_ID].Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container. + * @param {string} params.name Required. The project in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container. * @param {().AlertPolicy} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1825,7 +1850,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. + * @param {string} params.name Required. The alerting policy to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1894,7 +1919,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] + * @param {string} params.name Required. The alerting policy to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_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 @@ -1965,9 +1990,9 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering. - * @param {string} params.name The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. - * @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering. + * @param {string=} params.filter If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). + * @param {string} params.name Required. The project whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. + * @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). * @param {integer=} params.pageSize The maximum number of results to return in a single response. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2050,7 +2075,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. + * @param {string} params.name Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. * @param {string=} params.updateMask Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created. * @param {().AlertPolicy} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2125,7 +2150,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the alerting policy. The format is projects/[PROJECT_ID].Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[POLICY_ID], identifying the policy in the container. + * Required. The project in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container. */ name?: string; @@ -2142,7 +2167,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The alerting policy to delete. The format is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. + * Required. The alerting policy to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. */ name?: string; } @@ -2154,7 +2179,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The alerting policy to retrieve. The format is projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] + * Required. The alerting policy to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] */ name?: string; } @@ -2166,15 +2191,15 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering. + * If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). */ filter?: string; /** - * The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. + * Required. The project whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead. */ name?: string; /** - * A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering. + * A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). */ orderBy?: string; /** @@ -2194,7 +2219,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required if the policy exists. The resource name for this policy. The syntax is: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. + * Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Stackdriver Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. */ name?: string; /** @@ -2261,7 +2286,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project in which to create the time series. The format is "projects/PROJECT_ID_OR_NUMBER". + * @param {string} params.name The project in which to create the time series. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {().CreateCollectdTimeSeriesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2347,7 +2372,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the time series. The format is "projects/PROJECT_ID_OR_NUMBER". + * The project in which to create the time series. The format is: projects/[PROJECT_ID_OR_NUMBER] */ name?: string; @@ -2412,7 +2437,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project in which to create the group. The format is "projects/{project_id_or_number}". + * @param {string} params.name Required. The project in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {boolean=} params.validateOnly If true, validate this request but do not create the group. * @param {().Group} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2522,7 +2547,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}". + * @param {string} params.name Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] * @param {boolean=} params.recursive If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The default value is false. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2631,7 +2656,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The group to retrieve. The format is "projects/{project_id_or_number}/groups/{group_id}". + * @param {string} params.name Required. The group to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_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 @@ -2746,12 +2771,12 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.ancestorsOfGroup A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. - * @param {string=} params.childrenOfGroup A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty. - * @param {string=} params.descendantsOfGroup A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth. - * @param {string} params.name The project whose groups are to be listed. The format is "projects/{project_id_or_number}". + * @param {string=} params.ancestorsOfGroup A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. + * @param {string=} params.childrenOfGroup A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty. + * @param {string=} params.descendantsOfGroup A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth. + * @param {string} params.name Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + * @param {string=} params.pageToken If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method 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 @@ -2865,7 +2890,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically. + * @param {string} params.name Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically. * @param {boolean=} params.validateOnly If true, validate this request but do not update the existing group. * @param {().Group} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2938,7 +2963,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the group. The format is "projects/{project_id_or_number}". + * Required. The project in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER] */ name?: string; /** @@ -2959,7 +2984,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The group to delete. The format is "projects/{project_id_or_number}/groups/{group_id}". + * Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] */ name?: string; /** @@ -2975,7 +3000,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The group to retrieve. The format is "projects/{project_id_or_number}/groups/{group_id}". + * Required. The group to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] */ name?: string; } @@ -2987,19 +3012,19 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. + * A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty. */ ancestorsOfGroup?: string; /** - * A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty. + * A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whose parent_name field contains the group name. If no groups have this parent, the results are empty. */ childrenOfGroup?: string; /** - * A group name: "projects/{project_id_or_number}/groups/{group_id}". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth. + * A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns the descendants of the specified group. This is a superset of the results returned by the children_of_group filter, and includes children-of-children, and so forth. */ descendantsOfGroup?: string; /** - * The project whose groups are to be listed. The format is "projects/{project_id_or_number}". + * Required. The project whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] */ name?: string; /** @@ -3007,7 +3032,7 @@ export namespace monitoring_v3 { */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + * If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. */ pageToken?: string; } @@ -3019,7 +3044,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically. + * Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically. */ name?: string; /** @@ -3093,12 +3118,12 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: resource.type = "gce_instance" + * @param {string=} params.filter An optional list filter (https://cloud.google.com/monitoring/api/learn_more#filtering) describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: `resource.type = "gce_instance"` * @param {string=} params.interval.endTime Required. The end of the time interval. * @param {string=} params.interval.startTime Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. - * @param {string} params.name The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}". + * @param {string} params.name Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. - * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + * @param {string=} params.pageToken If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method 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 @@ -3176,7 +3201,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: resource.type = "gce_instance" + * An optional list filter (https://cloud.google.com/monitoring/api/learn_more#filtering) describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: `resource.type = "gce_instance"` */ filter?: string; /** @@ -3188,7 +3213,7 @@ export namespace monitoring_v3 { */ 'interval.startTime'?: string; /** - * The group whose members are listed. The format is "projects/{project_id_or_number}/groups/{group_id}". + * Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] */ name?: string; /** @@ -3196,7 +3221,7 @@ export namespace monitoring_v3 { */ pageSize?: number; /** - * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. + * If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. */ pageToken?: string; } @@ -3209,7 +3234,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.metricDescriptors.create - * @desc Creates a new metric descriptor. User-created metric descriptors define custom metrics. + * @desc Creates a new metric descriptor. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics). * @example * * // PRE-REQUISITES: * // --------------- @@ -3254,7 +3279,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {string} params.name Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {().MetricDescriptor} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3324,7 +3349,7 @@ export namespace monitoring_v3 { /** * monitoring.projects.metricDescriptors.delete - * @desc Deletes a metric descriptor. Only user-created custom metrics can be deleted. + * @desc Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted. * @example * * // PRE-REQUISITES: * // --------------- @@ -3370,7 +3395,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric". + * @param {string} params.name Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3480,7 +3505,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count". + * @param {string} params.name Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count". * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3597,8 +3622,8 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/") - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {string=} params.filter If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (https://cloud.google.com/monitoring/custom-metrics): metric.type = starts_with("custom.googleapis.com/") + * @param {string} params.name Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3685,7 +3710,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project on which to execute the request. The format is "projects/{project_id_or_number}". + * Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */ name?: string; @@ -3702,7 +3727,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example of {metric_id} is: "custom.googleapis.com/my_test_metric". + * Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of [METRIC_ID] is: "custom.googleapis.com/my_test_metric". */ name?: string; } @@ -3714,7 +3739,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The metric descriptor on which to execute the request. The format is "projects/{project_id_or_number}/metricDescriptors/{metric_id}". An example value of {metric_id} is "compute.googleapis.com/instance/disk/read_bytes_count". + * Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example value of [METRIC_ID] is "compute.googleapis.com/instance/disk/read_bytes_count". */ name?: string; } @@ -3726,11 +3751,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: metric.type = starts_with("custom.googleapis.com/") + * If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters) specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics (https://cloud.google.com/monitoring/custom-metrics): metric.type = starts_with("custom.googleapis.com/") */ filter?: string; /** - * The project on which to execute the request. The format is "projects/{project_id_or_number}". + * Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */ name?: string; /** @@ -3797,7 +3822,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database. + * @param {string} params.name Required. The monitored resource descriptor to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3921,8 +3946,8 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {string=} params.filter An optional filter (https://cloud.google.com/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id + * @param {string} params.name Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4017,7 +4042,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The monitored resource descriptor to get. The format is "projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}". The {resource_type} is a predefined type, such as cloudsql_database. + * Required. The monitored resource descriptor to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The [RESOURCE_TYPE] is a predefined type, such as cloudsql_database. */ name?: string; } @@ -4029,11 +4054,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An optional filter describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id + * An optional filter (https://cloud.google.com/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id */ filter?: string; /** - * The project on which to execute the request. The format is "projects/{project_id_or_number}". + * Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */ name?: string; /** @@ -4059,7 +4084,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}. + * @param {string} params.name Required. The channel type for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE] * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4139,7 +4164,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead. + * @param {string} params.name Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID_OR_NUMBER] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead. * @param {integer=} params.pageSize The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. * @param {string=} params.pageToken If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4239,7 +4264,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channel type for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}. + * Required. The channel type for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE] */ name?: string; } @@ -4251,7 +4276,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead. + * Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID_OR_NUMBER] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the GetNotificationChannelDescriptor operation, instead. */ name?: string; /** @@ -4277,7 +4302,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project on which to execute the request. The format is: projects/[PROJECT_ID] Note that this names the container into which the channel will be written. This does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel. + * @param {string} params.name Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel. * @param {().NotificationChannel} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4353,7 +4378,7 @@ export namespace monitoring_v3 { * * @param {object} params Parameters for request * @param {boolean=} params.force If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation. - * @param {string} params.name The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. + * @param {string} params.name Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_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 @@ -4422,7 +4447,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. + * @param {string} params.name Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_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 @@ -4493,7 +4518,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail. + * @param {string} params.name Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail. * @param {().GetNotificationChannelVerificationCodeRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4593,9 +4618,9 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering. - * @param {string} params.name The project on which to execute the request. The format is projects/[PROJECT_ID]. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation. - * @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering. + * @param {string=} params.filter If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). + * @param {string} params.name Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation. + * @param {string=} params.orderBy A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). * @param {integer=} params.pageSize The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. * @param {string=} params.pageToken If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4680,7 +4705,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. + * @param {string} params.name The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. * @param {string=} params.updateMask The fields to update. * @param {().NotificationChannel} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4753,7 +4778,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The notification channel to which to send a verification code. + * @param {string} params.name Required. The notification channel to which to send a verification code. * @param {().SendNotificationChannelVerificationCodeRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4826,7 +4851,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The notification channel to verify. + * @param {string} params.name Required. The notification channel to verify. * @param {().VerifyNotificationChannelRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4900,7 +4925,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project on which to execute the request. The format is: projects/[PROJECT_ID] Note that this names the container into which the channel will be written. This does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel. + * Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel. */ name?: string; @@ -4921,7 +4946,7 @@ export namespace monitoring_v3 { */ force?: boolean; /** - * The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. + * Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] */ name?: string; } @@ -4933,7 +4958,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The channel for which to execute the request. The format is projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]. + * Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] */ name?: string; } @@ -4945,7 +4970,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail. + * Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail. */ name?: string; @@ -4962,15 +4987,15 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering. + * If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). */ filter?: string; /** - * The project on which to execute the request. The format is projects/[PROJECT_ID]. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation. + * Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel operation. */ name?: string; /** - * A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering. + * A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending rather than ascending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering). */ orderBy?: string; /** @@ -4990,7 +5015,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The full REST resource name for this channel. The syntax is: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. + * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. */ name?: string; /** @@ -5011,7 +5036,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The notification channel to which to send a verification code. + * Required. The notification channel to which to send a verification code. */ name?: string; @@ -5028,7 +5053,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The notification channel to verify. + * Required. The notification channel to verify. */ name?: string; @@ -5091,7 +5116,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {string} params.name Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {().CreateTimeSeriesRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5210,18 +5235,18 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.aggregation.alignmentPeriod The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. - * @param {string=} params.aggregation.crossSeriesReducer The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. - * @param {string=} params.aggregation.groupByFields The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. - * @param {string=} params.aggregation.perSeriesAligner The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. - * @param {string=} params.filter A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name" + * @param {string=} params.aggregation.alignmentPeriod The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored. + * @param {string=} params.aggregation.crossSeriesReducer The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + * @param {string=} params.aggregation.groupByFields The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + * @param {string=} params.aggregation.perSeriesAligner An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + * @param {string=} params.filter Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name" * @param {string=} params.interval.endTime Required. The end of the time interval. * @param {string=} params.interval.startTime Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. - * @param {string} params.name The project on which to execute the request. The format is "projects/{project_id_or_number}". + * @param {string} params.name Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {string=} params.orderBy Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest). * @param {integer=} params.pageSize A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - * @param {string=} params.view Specifies which information is returned about the time series. + * @param {string=} params.view Required. Specifies which information is returned about the time series. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5299,7 +5324,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project on which to execute the request. The format is "projects/{project_id_or_number}". + * Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */ name?: string; @@ -5316,23 +5341,23 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned. + * The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored. */ 'aggregation.alignmentPeriod'?: string; /** - * The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + * The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. */ 'aggregation.crossSeriesReducer'?: string; /** - * The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored. + * The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. */ 'aggregation.groupByFields'?: string[]; /** - * The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned. + * An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. */ 'aggregation.perSeriesAligner'?: string; /** - * A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name" + * Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND metric.labels.instance_name = "my-instance-name" */ filter?: string; /** @@ -5344,7 +5369,7 @@ export namespace monitoring_v3 { */ 'interval.startTime'?: string; /** - * The project on which to execute the request. The format is "projects/{project_id_or_number}". + * Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */ name?: string; /** @@ -5360,7 +5385,7 @@ export namespace monitoring_v3 { */ pageToken?: string; /** - * Specifies which information is returned about the time series. + * Required. Specifies which information is returned about the time series. */ view?: string; } @@ -5378,7 +5403,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project in which to create the Uptime check. The format is projects/[PROJECT_ID]. + * @param {string} params.parent Required. The project in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {().UptimeCheckConfig} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5453,7 +5478,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The Uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * @param {string} params.name Required. The Uptime check configuration to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_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 @@ -5522,7 +5547,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The Uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * @param {string} params.name Required. The Uptime check configuration to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_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 @@ -5595,7 +5620,7 @@ export namespace monitoring_v3 { * @param {object} params Parameters for request * @param {integer=} params.pageSize The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. - * @param {string} params.parent The project whose Uptime check configurations are listed. The format is projects/[PROJECT_ID]. + * @param {string} params.parent Required. The project whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER] * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5678,7 +5703,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name A unique resource name for this Uptime check configuration. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. + * @param {string} params.name A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. * @param {string=} params.updateMask Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration. * @param {().UptimeCheckConfig} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5753,7 +5778,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project in which to create the Uptime check. The format is projects/[PROJECT_ID]. + * Required. The project in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER] */ parent?: string; @@ -5770,7 +5795,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The Uptime check configuration to delete. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * Required. The Uptime check configuration to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] */ name?: string; } @@ -5782,7 +5807,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The Uptime check configuration to retrieve. The format is projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]. + * Required. The Uptime check configuration to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] */ name?: string; } @@ -5802,7 +5827,7 @@ export namespace monitoring_v3 { */ pageToken?: string; /** - * The project whose Uptime check configurations are listed. The format is projects/[PROJECT_ID]. + * Required. The project whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER] */ parent?: string; } @@ -5814,7 +5839,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * A unique resource name for this Uptime check configuration. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. + * A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. */ name?: string; /** @@ -5845,8 +5870,8 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Resource name of the parent workspace. Of the form projects/{project_id}. - * @param {string=} params.serviceId Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern a-z0-9-+ + * @param {string} params.parent Required. Resource name of the parent workspace. The format is: projects/[PROJECT_ID_OR_NUMBER] + * @param {string=} params.serviceId Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ * @param {().Service} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -5918,7 +5943,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the Service to delete. Of the form projects/{project_id}/services/{service_id}. + * @param {string} params.name Required. Resource name of the Service to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_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 @@ -5986,7 +6011,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the Service. Of the form projects/{project_id}/services/{service_id}. + * @param {string} params.name Required. Resource name of the Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_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 @@ -6057,7 +6082,7 @@ export namespace monitoring_v3 { * @param {string=} params.filter A filter specifying what Services to return. The filter currently supports the following fields: - `identifier_case` - `app_engine.module_id` - `cloud_endpoints.service` - `cluster_istio.location` - `cluster_istio.cluster_name` - `cluster_istio.service_namespace` - `cluster_istio.service_name` identifier_case refers to which option in the identifier oneof is populated. For example, the filter identifier_case = "CUSTOM" would match all services with a value for the custom field. Valid options are "CUSTOM", "APP_ENGINE", "CLOUD_ENDPOINTS", and "CLUSTER_ISTIO". * @param {integer=} params.pageSize A non-negative number that is the maximum number of results to return. When 0, use default page size. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - * @param {string} params.parent Resource name of the parent Workspace. Of the form projects/{project_id}. + * @param {string} params.parent Required. Resource name of the parent containing the listed services, either a project or Stackdriver Account (workspace). The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_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 @@ -6132,7 +6157,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name for this Service. Of the form projects/{project_id}/services/{service_id}. + * @param {string} params.name Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID} * @param {string=} params.updateMask A set of field paths defining which fields to use for the update. * @param {().Service} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6203,11 +6228,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the parent workspace. Of the form projects/{project_id}. + * Required. Resource name of the parent workspace. The format is: projects/[PROJECT_ID_OR_NUMBER] */ parent?: string; /** - * Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern a-z0-9-+ + * Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ */ serviceId?: string; @@ -6223,7 +6248,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the Service to delete. Of the form projects/{project_id}/services/{service_id}. + * Required. Resource name of the Service to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */ name?: string; } @@ -6234,7 +6259,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the Service. Of the form projects/{project_id}/services/{service_id}. + * Required. Resource name of the Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */ name?: string; } @@ -6257,7 +6282,7 @@ export namespace monitoring_v3 { */ pageToken?: string; /** - * Resource name of the parent Workspace. Of the form projects/{project_id}. + * Required. Resource name of the parent containing the listed services, either a project or Stackdriver Account (workspace). The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID] */ parent?: string; } @@ -6268,7 +6293,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for this Service. Of the form projects/{project_id}/services/{service_id}. + * Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID} */ name?: string; /** @@ -6295,8 +6320,8 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent Resource name of the parent Service. Of the form projects/{project_id}/services/{service_id}. - * @param {string=} params.serviceLevelObjectiveId Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern a-z0-9-+ + * @param {string} params.parent Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] + * @param {string=} params.serviceLevelObjectiveId Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ * @param {().ServiceLevelObjective} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6373,7 +6398,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the ServiceLevelObjective to delete. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}. + * @param {string} params.name Required. Resource name of the ServiceLevelObjective to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -6442,7 +6467,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name of the ServiceLevelObjective to get. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}. + * @param {string} params.name Required. Resource name of the ServiceLevelObjective to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * @param {string=} params.view View of the ServiceLevelObjective to return. If DEFAULT, return the ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6519,7 +6544,7 @@ export namespace monitoring_v3 { * @param {string=} params.filter A filter specifying what ServiceLevelObjectives to return. * @param {integer=} params.pageSize A non-negative number that is the maximum number of results to return. When 0, use default page size. * @param {string=} params.pageToken If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call. - * @param {string} params.parent Resource name of the parent Service. Of the form projects/{project_id}/services/{service_id}. + * @param {string} params.parent Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] * @param {string=} params.view View of the ServiceLevelObjectives to return. If DEFAULT, return each ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -6603,7 +6628,7 @@ export namespace monitoring_v3 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name Resource name for this ServiceLevelObjective. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}. + * @param {string} params.name Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] * @param {string=} params.updateMask A set of field paths defining which fields to use for the update. * @param {().ServiceLevelObjective} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -6680,11 +6705,11 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the parent Service. Of the form projects/{project_id}/services/{service_id}. + * Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */ parent?: string; /** - * Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern a-z0-9-+ + * Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ */ serviceLevelObjectiveId?: string; @@ -6701,7 +6726,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the ServiceLevelObjective to delete. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}. + * Required. Resource name of the ServiceLevelObjective to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */ name?: string; } @@ -6713,7 +6738,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name of the ServiceLevelObjective to get. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}. + * Required. Resource name of the ServiceLevelObjective to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */ name?: string; /** @@ -6741,7 +6766,7 @@ export namespace monitoring_v3 { */ pageToken?: string; /** - * Resource name of the parent Service. Of the form projects/{project_id}/services/{service_id}. + * Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */ parent?: string; /** @@ -6757,7 +6782,7 @@ export namespace monitoring_v3 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Resource name for this ServiceLevelObjective. Of the form projects/{project_id}/services/{service_id}/serviceLevelObjectives/{slo_name}. + * Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */ name?: string; /** diff --git a/src/apis/replicapool/README.md b/src/apis/osconfig/README.md similarity index 78% rename from src/apis/replicapool/README.md rename to src/apis/osconfig/README.md index 86da2bc3a0..98e3898e4a 100644 --- a/src/apis/replicapool/README.md +++ b/src/apis/osconfig/README.md @@ -1,8 +1,8 @@ Google Inc. logo -# replicapool +# osconfig -> The Replica Pool API allows users to declaratively provision and manage groups of Google Compute Engine instances based on a common template. +> OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. ## Installation @@ -19,17 +19,17 @@ This library can be used in a browser. To prepare a single file bundle, clone th [repository](https://github.com/googleapis/google-api-nodejs-client) and run ```sh -$ cd src/apis/replicapool +$ cd src/apis/osconfig $ npm install $ npm run webpack ``` -The generated bundle will be written to `dist/replicapool.min.js`. Use it from your HTML file: +The generated bundle will be written to `dist/osconfig.min.js`. Use it from your HTML file: ```html - + ``` diff --git a/src/apis/replicapool/index.ts b/src/apis/osconfig/index.ts similarity index 62% rename from src/apis/replicapool/index.ts rename to src/apis/osconfig/index.ts index 7b30e3952c..e630635384 100644 --- a/src/apis/replicapool/index.ts +++ b/src/apis/osconfig/index.ts @@ -14,23 +14,21 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {replicapool_v1beta1} from './v1beta1'; +import {osconfig_v1beta} from './v1beta'; export const VERSIONS = { - v1beta1: replicapool_v1beta1.Replicapool, + v1beta: osconfig_v1beta.Osconfig, }; -export function replicapool( - version: 'v1beta1' -): replicapool_v1beta1.Replicapool; -export function replicapool( - options: replicapool_v1beta1.Options -): replicapool_v1beta1.Replicapool; -export function replicapool( +export function osconfig(version: 'v1beta'): osconfig_v1beta.Osconfig; +export function osconfig( + options: osconfig_v1beta.Options +): osconfig_v1beta.Osconfig; +export function osconfig( this: GoogleConfigurable, - versionOrOptions: 'v1beta1' | replicapool_v1beta1.Options + versionOrOptions: 'v1beta' | osconfig_v1beta.Options ) { - return getAPI('replicapool', versionOrOptions, VERSIONS, this); + return getAPI('osconfig', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); diff --git a/src/apis/plusDomains/package.json b/src/apis/osconfig/package.json similarity index 93% rename from src/apis/plusDomains/package.json rename to src/apis/osconfig/package.json index 54b675dac6..7f1c8befa7 100644 --- a/src/apis/plusDomains/package.json +++ b/src/apis/osconfig/package.json @@ -1,7 +1,7 @@ { - "name": "@google/plusDomains", + "name": "@google/osconfig", "version": "0.1.0", - "description": "plusDomains", + "description": "osconfig", "main": "build/index.js", "types": "build/index.d.ts", "keywords": [ diff --git a/src/apis/plusDomains/tsconfig.json b/src/apis/osconfig/tsconfig.json similarity index 100% rename from src/apis/plusDomains/tsconfig.json rename to src/apis/osconfig/tsconfig.json diff --git a/src/apis/osconfig/v1beta.ts b/src/apis/osconfig/v1beta.ts new file mode 100644 index 0000000000..ab141b8544 --- /dev/null +++ b/src/apis/osconfig/v1beta.ts @@ -0,0 +1,2704 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace osconfig_v1beta { + export interface Options extends GlobalOptions { + version: 'v1beta'; + } + + 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 OS Config API + * + * OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances. + * + * @example + * const {google} = require('googleapis'); + * const osconfig = google.osconfig('v1beta'); + * + * @namespace osconfig + * @type {Function} + * @version v1beta + * @variation v1beta + * @param {object=} options Options for Osconfig + */ + export class Osconfig { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Represents a single Apt package repository. This repository is added to a repo file that is stored at `/etc/apt/sources.list.d/google_osconfig.list`. + */ + export interface Schema$AptRepository { + /** + * Type of archive files in this repository. The default behavior is DEB. + */ + archiveType?: string | null; + /** + * Required. List of components for this repository. Must contain at least one item. + */ + components?: string[] | null; + /** + * Required. Distribution of this repository. + */ + distribution?: string | null; + /** + * URI of the key file for this repository. The agent maintains a keyring at `/etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg` containing all the keys in any applied guest policy. + */ + gpgKey?: string | null; + /** + * Required. URI for this repository. + */ + uri?: string | null; + } + /** + * Apt patching is completed by executing `apt-get update && apt-get upgrade`. Additional options can be set to control how this is executed. + */ + export interface Schema$AptSettings { + /** + * List of packages to exclude from update. These packages will be excluded + */ + excludes?: string[] | null; + /** + * An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field cannot be specified with any other patch configuration fields. + */ + exclusivePackages?: string[] | null; + /** + * By changing the type to DIST, the patching is performed using `apt-get dist-upgrade` instead. + */ + type?: string | null; + } + /** + * An assignment represents the group or groups of VM instances that the policy applies to. If an assignment is empty, it applies to all VM instances. Otherwise, the targeted VM instances must meet all the criteria specified. So if both labels and zones are specified, the policy applies to VM instances with those labels and in those zones. + */ + export interface Schema$Assignment { + /** + * Targets instances matching at least one of these label sets. This allows an assignment to target disparate groups, for example "env=prod or env=staging". + */ + groupLabels?: Schema$AssignmentGroupLabel[]; + /** + * Targets VM instances whose name starts with one of these prefixes. Like labels, this is another way to group VM instances when targeting configs, for example prefix="prod-". Only supported for project-level policies. + */ + instanceNamePrefixes?: string[] | null; + /** + * Targets any of the instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME]`. Instance targeting is uncommon and is supported to facilitate the management of changes by the instance or to target specific VM instances for development and testing. Only supported for project-level policies and must reference instances within this project. + */ + instances?: string[] | null; + /** + * Targets VM instances matching at least one of the following OS types. VM instances must match all supplied criteria for a given OsType to be included. + */ + osTypes?: Schema$AssignmentOsType[]; + /** + * Targets instances in any of these zones. Leave empty to target instances in any zone. Zonal targeting is uncommon and is supported to facilitate the management of changes by zone. + */ + zones?: string[] | null; + } + /** + * Represents a group of VM intances that can be identified as having all these labels, for example "env=prod and app=web". + */ + export interface Schema$AssignmentGroupLabel { + /** + * Google Compute Engine instance labels that must be present for an instance to be included in this assignment group. + */ + labels?: {[key: string]: string} | null; + } + /** + * Defines the criteria for selecting VM Instances by OS type. + */ + export interface Schema$AssignmentOsType { + /** + * Targets VM instances with OS Inventory enabled and having the following OS architecture. + */ + osArchitecture?: string | null; + /** + * Targets VM instances with OS Inventory enabled and having the following OS short name, for example "debian" or "windows". + */ + osShortName?: string | null; + /** + * Targets VM instances with OS Inventory enabled and having the following following OS version. + */ + osVersion?: string | null; + } + /** + * Message for canceling a patch job. + */ + export interface Schema$CancelPatchJobRequest {} + /** + * The effective guest policy that applies to a VM instance. + */ + export interface Schema$EffectiveGuestPolicy { + /** + * List of package repository configurations assigned to the VM instance. + */ + packageRepositories?: Schema$EffectiveGuestPolicySourcedPackageRepository[]; + /** + * List of package configurations assigned to the VM instance. + */ + packages?: Schema$EffectiveGuestPolicySourcedPackage[]; + /** + * List of recipes assigned to the VM instance. + */ + softwareRecipes?: Schema$EffectiveGuestPolicySourcedSoftwareRecipe[]; + } + /** + * A guest policy package including its source. + */ + export interface Schema$EffectiveGuestPolicySourcedPackage { + /** + * A software package to configure on the VM instance. + */ + package?: Schema$Package; + /** + * Name of the guest policy providing this config. + */ + source?: string | null; + } + /** + * A guest policy package repository including its source. + */ + export interface Schema$EffectiveGuestPolicySourcedPackageRepository { + /** + * A software package repository to configure on the VM instance. + */ + packageRepository?: Schema$PackageRepository; + /** + * Name of the guest policy providing this config. + */ + source?: string | null; + } + /** + * A guest policy recipe including its source. + */ + export interface Schema$EffectiveGuestPolicySourcedSoftwareRecipe { + /** + * A software recipe to configure on the VM instance. + */ + softwareRecipe?: Schema$SoftwareRecipe; + /** + * Name of the guest policy providing this config. + */ + source?: string | null; + } + /** + * 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 {} + /** + * A step that runs an executable for a PatchJob. + */ + export interface Schema$ExecStep { + /** + * The ExecStepConfig for all Linux VMs targeted by the PatchJob. + */ + linuxExecStepConfig?: Schema$ExecStepConfig; + /** + * The ExecStepConfig for all Windows VMs targeted by the PatchJob. + */ + windowsExecStepConfig?: Schema$ExecStepConfig; + } + /** + * Common configurations for an ExecStep. + */ + export interface Schema$ExecStepConfig { + /** + * Defaults to [0]. A list of possible return values that the execution can return to indicate a success. + */ + allowedSuccessCodes?: number[] | null; + /** + * A Google Cloud Storage object containing the executable. + */ + gcsObject?: Schema$GcsObject; + /** + * The script interpreter to use to run the script. If no interpreter is specified the script will be executed directly, which will likely only succeed for scripts with [shebang lines] (https://en.wikipedia.org/wiki/Shebang_\(Unix\)). + */ + interpreter?: string | null; + /** + * An absolute path to the executable on the VM. + */ + localPath?: string | null; + } + /** + * A request message to initiate patching across Google Compute Engine instances. + */ + export interface Schema$ExecutePatchJobRequest { + /** + * Description of the patch job. Length of the description is limited to 1024 characters. + */ + description?: string | null; + /** + * Display name for this patch job. This does not have to be unique. + */ + displayName?: string | null; + /** + * If this patch is a dry-run only, instances are contacted but will do nothing. + */ + dryRun?: boolean | null; + /** + * Duration of the patch job. After the duration ends, the patch job times out. + */ + duration?: string | null; + /** + * Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels. + */ + instanceFilter?: Schema$PatchInstanceFilter; + /** + * Patch configuration being applied. If omitted, instances are patched using the default configurations. + */ + patchConfig?: Schema$PatchConfig; + } + /** + * Google Cloud Storage object representation. + */ + export interface Schema$GcsObject { + /** + * Required. Bucket of the Google Cloud Storage object. + */ + bucket?: string | null; + /** + * Required. Generation number of the Google Cloud Storage object. This is used to ensure that the ExecStep specified by this PatchJob does not change. + */ + generationNumber?: string | null; + /** + * Required. Name of the Google Cloud Storage object. + */ + object?: string | null; + } + /** + * Represents a Goo package repository. These is added to a repo file that is stored at C:/ProgramData/GooGet/repos/google_osconfig.repo. + */ + export interface Schema$GooRepository { + /** + * Required. The name of the repository. + */ + name?: string | null; + /** + * Required. The url of the repository. + */ + url?: string | null; + } + /** + * Googet patching is performed by running `googet update`. + */ + export interface Schema$GooSettings {} + /** + * An OS Config resource representing a guest configuration policy. These policies represent the desired state for VM instance guest environments including packages to install or remove, package repository configurations, and software to install. + */ + export interface Schema$GuestPolicy { + /** + * Required. Specifies the VM instances that are assigned to this policy. This allows you to target sets or groups of VM instances by different parameters such as labels, names, OS, or zones. If left empty, all VM instances underneath this policy are targeted. At the same level in the resource hierarchy (that is within a project), the service prevents the creation of multiple policies that conflict with each other. For more information, see how the service [handles assignment conflicts](/compute/docs/os-config-management/create-guest-policy#handle-conflicts). + */ + assignment?: Schema$Assignment; + /** + * Output only. Time this guest policy was created. + */ + createTime?: string | null; + /** + * Description of the guest policy. Length of the description is limited to 1024 characters. + */ + description?: string | null; + /** + * The etag for this guest policy. If this is provided on update, it must match the server's etag. + */ + etag?: string | null; + /** + * Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. + */ + name?: string | null; + /** + * A list of package repositories to configure on the VM instance. This is done before any other configs are applied so they can use these repos. Package repositories are only configured if the corresponding package manager(s) are available. + */ + packageRepositories?: Schema$PackageRepository[]; + /** + * The software packages to be managed by this policy. + */ + packages?: Schema$Package[]; + /** + * A list of Recipes to install on the VM instance. + */ + recipes?: Schema$SoftwareRecipe[]; + /** + * Output only. Last time this guest policy was updated. + */ + updateTime?: string | null; + } + /** + * A response message for listing guest policies. + */ + export interface Schema$ListGuestPoliciesResponse { + /** + * The list of GuestPolicies. + */ + guestPolicies?: Schema$GuestPolicy[]; + /** + * A pagination token that can be used to get the next page of guest policies. + */ + nextPageToken?: string | null; + } + /** + * A response message for listing patch deployments. + */ + export interface Schema$ListPatchDeploymentsResponse { + /** + * A pagination token that can be used to get the next page of patch deployments. + */ + nextPageToken?: string | null; + /** + * The list of patch deployments. + */ + patchDeployments?: Schema$PatchDeployment[]; + } + /** + * A response message for listing the instances details for a patch job. + */ + export interface Schema$ListPatchJobInstanceDetailsResponse { + /** + * A pagination token that can be used to get the next page of results. + */ + nextPageToken?: string | null; + /** + * A list of instance status. + */ + patchJobInstanceDetails?: Schema$PatchJobInstanceDetails[]; + } + /** + * A response message for listing patch jobs. + */ + export interface Schema$ListPatchJobsResponse { + /** + * A pagination token that can be used to get the next page of results. + */ + nextPageToken?: string | null; + /** + * The list of patch jobs. + */ + patchJobs?: Schema$PatchJob[]; + } + /** + * A request message for getting the effective guest policy assigned to the instance. + */ + export interface Schema$LookupEffectiveGuestPolicyRequest { + /** + * Architecture of OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance. + */ + osArchitecture?: string | null; + /** + * Short name of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that instance. + */ + osShortName?: string | null; + /** + * Version of the OS running on the instance. The OS Config agent only provides this field for targeting if OS Inventory is enabled for that VM instance. + */ + osVersion?: string | null; + } + /** + * Represents a monthly schedule. An example of a valid monthly schedule is "on the third Tuesday of the month" or "on the 15th of the month". + */ + export interface Schema$MonthlySchedule { + /** + * Required. One day of the month. 1-31 indicates the 1st to the 31st day. -1 indicates the last day of the month. Months without the target day will be skipped. For example, a schedule to run "every month on the 31st" will not run in February, April, June, etc. + */ + monthDay?: number | null; + /** + * Required. Week day in a month. + */ + weekDayOfMonth?: Schema$WeekDayOfMonth; + } + /** + * Sets the time for a one time patch deployment. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + */ + export interface Schema$OneTimeSchedule { + /** + * Required. The desired patch job execution time. + */ + executeTime?: string | null; + } + /** + * Package is a reference to the software package to be installed or removed. The agent on the VM instance uses the system package manager to apply the config. These are the commands that the agent uses to install or remove packages. Apt install: `apt-get update && apt-get -y install package1 package2 package3` remove: `apt-get -y remove package1 package2 package3` Yum install: `yum -y install package1 package2 package3` remove: `yum -y remove package1 package2 package3` Zypper install: `zypper install package1 package2 package3` remove: `zypper rm package1 package2` Googet install: `googet -noconfirm install package1 package2 package3` remove: `googet -noconfirm remove package1 package2 package3` + */ + export interface Schema$Package { + /** + * The desired_state the agent should maintain for this package. The default is to ensure the package is installed. + */ + desiredState?: string | null; + /** + * Type of package manager that can be used to install this package. If a system does not have the package manager, the package is not installed or removed no error message is returned. By default, or if you specify `ANY`, the agent attempts to install and remove this package using the default package manager. This is useful when creating a policy that applies to different types of systems. The default behavior is ANY. + */ + manager?: string | null; + /** + * Required. The name of the package. A package is uniquely identified for conflict validation by checking the package name and the manager(s) that the package targets. + */ + name?: string | null; + } + /** + * A package repository. + */ + export interface Schema$PackageRepository { + /** + * An Apt Repository. + */ + apt?: Schema$AptRepository; + /** + * A Goo Repository. + */ + goo?: Schema$GooRepository; + /** + * A Yum Repository. + */ + yum?: Schema$YumRepository; + /** + * A Zypper Repository. + */ + zypper?: Schema$ZypperRepository; + } + /** + * Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. + */ + export interface Schema$PatchConfig { + /** + * Apt update settings. Use this setting to override the default `apt` patch rules. + */ + apt?: Schema$AptSettings; + /** + * Goo update settings. Use this setting to override the default `goo` patch rules. + */ + goo?: Schema$GooSettings; + /** + * The `ExecStep` to run after the patch update. + */ + postStep?: Schema$ExecStep; + /** + * The `ExecStep` to run before the patch update. + */ + preStep?: Schema$ExecStep; + /** + * Post-patch reboot settings. + */ + rebootConfig?: string | null; + /** + * Windows update settings. Use this override the default windows patch rules. + */ + windowsUpdate?: Schema$WindowsUpdateSettings; + /** + * Yum update settings. Use this setting to override the default `yum` patch rules. + */ + yum?: Schema$YumSettings; + /** + * Zypper update settings. Use this setting to override the default `zypper` patch rules. + */ + zypper?: Schema$ZypperSettings; + } + /** + * Patch deployments are configurations that individual patch jobs use to complete a patch. These configurations include instance filter, package repository settings, and a schedule. + */ + export interface Schema$PatchDeployment { + /** + * Output only. Time the patch deployment was created. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + */ + createTime?: string | null; + /** + * Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. + */ + description?: string | null; + /** + * Optional. Duration of the patch. After the duration ends, the patch times out. + */ + duration?: string | null; + /** + * Required. VM instances to patch. + */ + instanceFilter?: Schema$PatchInstanceFilter; + /** + * Output only. The last time a patch job was started by this deployment. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + */ + lastExecuteTime?: string | null; + /** + * Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. + */ + name?: string | null; + /** + * Required. Schedule a one-time execution. + */ + oneTimeSchedule?: Schema$OneTimeSchedule; + /** + * Optional. Patch configuration that is applied. + */ + patchConfig?: Schema$PatchConfig; + /** + * Required. Schedule recurring executions. + */ + recurringSchedule?: Schema$RecurringSchedule; + /** + * Output only. Time the patch deployment was last updated. Timestamp is in <a href="https://www.ietf.org/rfc/rfc3339.txt" target="_blank">RFC3339</a> text format. + */ + updateTime?: string | null; + } + /** + * A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. + */ + export interface Schema$PatchInstanceFilter { + /** + * Target all VM instances in the project. If true, no other criteria is permitted. + */ + all?: boolean | null; + /** + * Targets VM instances matching at least one of these label sets. This allows targeting of disparate groups, for example "env=prod or env=staging". + */ + groupLabels?: Schema$PatchInstanceFilterGroupLabel[]; + /** + * Targets VMs whose name starts with one of these prefixes. Similar to labels, this is another way to group VMs when targeting configs, for example prefix="prod-". + */ + instanceNamePrefixes?: string[] | null; + /** + * Targets any of the VM instances specified. Instances are specified by their URI in the form `zones/[ZONE]/instances/[INSTANCE_NAME], `projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]`, or `https://www.googleapis.com/compute/v1/projects/[PROJECT_ID]/zones/[ZONE]/instances/[INSTANCE_NAME]` + */ + instances?: string[] | null; + /** + * Targets VM instances in ANY of these zones. Leave empty to target VM instances in any zone. + */ + zones?: string[] | null; + } + /** + * Represents a group of VMs that can be identified as having all these labels, for example "env=prod and app=web". + */ + export interface Schema$PatchInstanceFilterGroupLabel { + /** + * Google Compute Engine instance labels that must be present for a VM instance to be targeted by this filter. + */ + labels?: {[key: string]: string} | null; + } + /** + * A high level representation of a patch job that is either in progress or has completed. Instances details are not included in the job. To paginate through instance details, use ListPatchJobInstanceDetails. + */ + export interface Schema$PatchJob { + /** + * Time this patch job was created. + */ + createTime?: string | null; + /** + * Description of the patch job. Length of the description is limited to 1024 characters. + */ + description?: string | null; + /** + * Display name for this patch job. This is not a unique identifier. + */ + displayName?: string | null; + /** + * If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. + */ + dryRun?: boolean | null; + /** + * Duration of the patch job. After the duration ends, the patch job times out. + */ + duration?: string | null; + /** + * If this patch job failed, this message provides information about the failure. + */ + errorMessage?: string | null; + /** + * Summary of instance details. + */ + instanceDetailsSummary?: Schema$PatchJobInstanceDetailsSummary; + /** + * Instances to patch. + */ + instanceFilter?: Schema$PatchInstanceFilter; + /** + * Unique identifier for this patch job in the form `projects/x/patchJobs/x + */ + name?: string | null; + /** + * Patch configuration being applied. + */ + patchConfig?: Schema$PatchConfig; + /** + * Output only. Name of the patch deployment that created this patch job. + */ + patchDeployment?: string | null; + /** + * Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. + */ + percentComplete?: number | null; + /** + * The current state of the PatchJob . + */ + state?: string | null; + /** + * Last time this patch job was updated. + */ + updateTime?: string | null; + } + /** + * Patch details for a VM instance. + */ + export interface Schema$PatchJobInstanceDetails { + /** + * The number of times the agent that the agent attempts to apply the patch. + */ + attemptCount?: string | null; + /** + * If the patch fails, this field provides the reason. + */ + failureReason?: string | null; + /** + * The unique identifier for the instance. This identifier is defined by the server. + */ + instanceSystemId?: string | null; + /** + * The instance name in the form `projects/x/zones/x/instances/x + */ + name?: string | null; + /** + * Current state of instance patch. + */ + state?: string | null; + } + /** + * A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. + */ + export interface Schema$PatchJobInstanceDetailsSummary { + /** + * Number of instances that have acked and will start shortly. + */ + ackedInstanceCount?: string | null; + /** + * Number of instances that are applying patches. + */ + applyingPatchesInstanceCount?: string | null; + /** + * Number of instances that are downloading patches. + */ + downloadingPatchesInstanceCount?: string | null; + /** + * Number of instances that failed. + */ + failedInstanceCount?: string | null; + /** + * Number of instances that are inactive. + */ + inactiveInstanceCount?: string | null; + /** + * Number of instances that do not appear to be running the agent. Check to ensure that the agent is installed, running, and able to communicate with the service. + */ + noAgentDetectedInstanceCount?: string | null; + /** + * Number of instances notified about patch job. + */ + notifiedInstanceCount?: string | null; + /** + * Number of instances pending patch job. + */ + pendingInstanceCount?: string | null; + /** + * Number of instances that are running the post-patch step. + */ + postPatchStepInstanceCount?: string | null; + /** + * Number of instances that are running the pre-patch step. + */ + prePatchStepInstanceCount?: string | null; + /** + * Number of instances rebooting. + */ + rebootingInstanceCount?: string | null; + /** + * Number of instances that have started. + */ + startedInstanceCount?: string | null; + /** + * Number of instances that have completed successfully. + */ + succeededInstanceCount?: string | null; + /** + * Number of instances that require reboot. + */ + succeededRebootRequiredInstanceCount?: string | null; + /** + * Number of instances that exceeded the time out while applying the patch. + */ + timedOutInstanceCount?: string | null; + } + /** + * Sets the time for recurring patch deployments. + */ + export interface Schema$RecurringSchedule { + /** + * Optional. The end time at which a recurring patch deployment schedule is no longer active. + */ + endTime?: string | null; + /** + * Required. The frequency unit of this recurring schedule. + */ + frequency?: string | null; + /** + * Output only. The time the last patch job ran successfully. + */ + lastExecuteTime?: string | null; + /** + * Required. Schedule with monthly executions. + */ + monthly?: Schema$MonthlySchedule; + /** + * Output only. The time the next patch job is scheduled to run. + */ + nextExecuteTime?: string | null; + /** + * Optional. The time that the recurring schedule becomes effective. Defaults to `create_time` of the patch deployment. + */ + startTime?: string | null; + /** + * Required. Time of the day to run a recurring deployment. + */ + timeOfDay?: Schema$TimeOfDay; + /** + * Required. Defines the time zone that `time_of_day` is relative to. The rules for daylight saving time are determined by the chosen time zone. + */ + timeZone?: Schema$TimeZone; + /** + * Required. Schedule with weekly executions. + */ + weekly?: Schema$WeeklySchedule; + } + /** + * A software recipe is a set of instructions for installing and configuring a piece of software. It consists of a set of artifacts that are downloaded, and a set of steps that install, configure, and/or update the software. Recipes support installing and updating software from artifacts in the following formats: Zip archive, Tar archive, Windows MSI, Debian package, and RPM package. Additionally, recipes support executing a script (either defined in a file or directly in this api) in bash, sh, cmd, and powershell. Updating a software recipe If a recipe is assigned to an instance and there is a recipe with the same name but a lower version already installed and the assigned state of the recipe is `INSTALLED_KEEP_UPDATED`, then the recipe is updated to the new version. Script Working Directories Each script or execution step is run in its own temporary directory which is deleted after completing the step. + */ + export interface Schema$SoftwareRecipe { + /** + * Resources available to be used in the steps in the recipe. + */ + artifacts?: Schema$SoftwareRecipeArtifact[]; + /** + * Default is INSTALLED. The desired state the agent should maintain for this recipe. INSTALLED: The software recipe is installed on the instance but won't be updated to new versions. INSTALLED_KEEP_UPDATED: The software recipe is installed on the instance. The recipe is updated to a higher version, if a higher version of the recipe is assigned to this instance. REMOVE: Remove is unsupported for software recipes and attempts to create or update a recipe to the REMOVE state is rejected. + */ + desiredState?: string | null; + /** + * Actions to be taken for installing this recipe. On failure it stops executing steps and does not attempt another installation. Any steps taken (including partially completed steps) are not rolled back. + */ + installSteps?: Schema$SoftwareRecipeStep[]; + /** + * Required. Unique identifier for the recipe. Only one recipe with a given name is installed on an instance. Names are also used to identify resources which helps to determine whether guest policies have conflicts. This means that requests to create multiple recipes with the same name and version are rejected since they could potentially have conflicting assignments. + */ + name?: string | null; + /** + * Actions to be taken for updating this recipe. On failure it stops executing steps and does not attempt another update for this recipe. Any steps taken (including partially completed steps) are not rolled back. + */ + updateSteps?: Schema$SoftwareRecipeStep[]; + /** + * The version of this software recipe. Version can be up to 4 period separated numbers (e.g. 12.34.56.78). + */ + version?: string | null; + } + /** + * Specifies a resource to be used in the recipe. + */ + export interface Schema$SoftwareRecipeArtifact { + /** + * Defaults to false. When false, recipes are subject to validations based on the artifact type: Remote: A checksum must be specified, and only protocols with transport-layer security are permitted. GCS: An object generation number must be specified. + */ + allowInsecure?: boolean | null; + /** + * A Google Cloud Storage artifact. + */ + gcs?: Schema$SoftwareRecipeArtifactGcs; + /** + * Required. Id of the artifact, which the installation and update steps of this recipe can reference. Artifacts in a recipe cannot have the same id. + */ + id?: string | null; + /** + * A generic remote artifact. + */ + remote?: Schema$SoftwareRecipeArtifactRemote; + } + /** + * Specifies an artifact available as a Google Cloud Storage object. + */ + export interface Schema$SoftwareRecipeArtifactGcs { + /** + * Bucket of the Google Cloud Storage object. Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `my-bucket`. + */ + bucket?: string | null; + /** + * Must be provided if allow_insecure is false. Generation number of the Google Cloud Storage object. `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `1234567`. + */ + generation?: string | null; + /** + * Name of the Google Cloud Storage object. As specified [here] (https://cloud.google.com/storage/docs/naming#objectnames) Given an example URL: `https://storage.googleapis.com/my-bucket/foo/bar#1234567` this value would be `foo/bar`. + */ + object?: string | null; + } + /** + * Specifies an artifact available via some URI. + */ + export interface Schema$SoftwareRecipeArtifactRemote { + /** + * Must be provided if `allow_insecure` is `false`. SHA256 checksum in hex format, to compare to the checksum of the artifact. If the checksum is not empty and it doesn't match the artifact then the recipe installation fails before running any of the steps. + */ + checksum?: string | null; + /** + * URI from which to fetch the object. It should contain both the protocol and path following the format {protocol}://{location}. + */ + uri?: string | null; + } + /** + * An action that can be taken as part of installing or updating a recipe. + */ + export interface Schema$SoftwareRecipeStep { + /** + * Extracts an archive into the specified directory. + */ + archiveExtraction?: Schema$SoftwareRecipeStepExtractArchive; + /** + * Installs a deb file via dpkg. + */ + dpkgInstallation?: Schema$SoftwareRecipeStepInstallDpkg; + /** + * Copies a file onto the instance. + */ + fileCopy?: Schema$SoftwareRecipeStepCopyFile; + /** + * Executes an artifact or local file. + */ + fileExec?: Schema$SoftwareRecipeStepExecFile; + /** + * Installs an MSI file. + */ + msiInstallation?: Schema$SoftwareRecipeStepInstallMsi; + /** + * Installs an rpm file via the rpm utility. + */ + rpmInstallation?: Schema$SoftwareRecipeStepInstallRpm; + /** + * Runs commands in a shell. + */ + scriptRun?: Schema$SoftwareRecipeStepRunScript; + } + /** + * Copies the artifact to the specified path on the instance. + */ + export interface Schema$SoftwareRecipeStepCopyFile { + /** + * Required. The id of the relevant artifact in the recipe. + */ + artifactId?: string | null; + /** + * Required. The absolute path on the instance to put the file. + */ + destination?: string | null; + /** + * Whether to allow this step to overwrite existing files. If this is false and the file already exists the file is not overwritten and the step is considered a success. Defaults to false. + */ + overwrite?: boolean | null; + /** + * Consists of three octal digits which represent, in order, the permissions of the owner, group, and other users for the file (similarly to the numeric mode used in the linux chmod utility). Each digit represents a three bit number with the 4 bit corresponding to the read permissions, the 2 bit corresponds to the write bit, and the one bit corresponds to the execute permission. Default behavior is 755. Below are some examples of permissions and their associated values: read, write, and execute: 7 read and execute: 5 read and write: 6 read only: 4 + */ + permissions?: string | null; + } + /** + * Executes an artifact or local file. + */ + export interface Schema$SoftwareRecipeStepExecFile { + /** + * Defaults to [0]. A list of possible return values that the program can return to indicate a success. + */ + allowedExitCodes?: number[] | null; + /** + * Arguments to be passed to the provided executable. + */ + args?: string[] | null; + /** + * The id of the relevant artifact in the recipe. + */ + artifactId?: string | null; + /** + * The absolute path of the file on the local filesystem. + */ + localPath?: string | null; + } + /** + * Extracts an archive of the type specified in the specified directory. + */ + export interface Schema$SoftwareRecipeStepExtractArchive { + /** + * Required. The id of the relevant artifact in the recipe. + */ + artifactId?: string | null; + /** + * Directory to extract archive to. Defaults to `/` on Linux or `C:\` on Windows. + */ + destination?: string | null; + /** + * Required. The type of the archive to extract. + */ + type?: string | null; + } + /** + * Installs a deb via dpkg. + */ + export interface Schema$SoftwareRecipeStepInstallDpkg { + /** + * Required. The id of the relevant artifact in the recipe. + */ + artifactId?: string | null; + } + /** + * Installs an MSI file. + */ + export interface Schema$SoftwareRecipeStepInstallMsi { + /** + * Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] + */ + allowedExitCodes?: number[] | null; + /** + * Required. The id of the relevant artifact in the recipe. + */ + artifactId?: string | null; + /** + * The flags to use when installing the MSI defaults to ["/i"] (i.e. the install flag). + */ + flags?: string[] | null; + } + /** + * Installs an rpm file via the rpm utility. + */ + export interface Schema$SoftwareRecipeStepInstallRpm { + /** + * Required. The id of the relevant artifact in the recipe. + */ + artifactId?: string | null; + } + /** + * Runs a script through an interpreter. + */ + export interface Schema$SoftwareRecipeStepRunScript { + /** + * Return codes that indicate that the software installed or updated successfully. Behaviour defaults to [0] + */ + allowedExitCodes?: number[] | null; + /** + * The script interpreter to use to run the script. If no interpreter is specified the script is executed directly, which likely only succeed for scripts with [shebang lines](https://en.wikipedia.org/wiki/Shebang_\(Unix\)). + */ + interpreter?: string | null; + /** + * Required. The shell script to be executed. + */ + script?: string | null; + } + /** + * Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. + */ + export interface Schema$TimeOfDay { + /** + * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Minutes of hour of day. Must be from 0 to 59. + */ + minutes?: number | null; + /** + * Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. + */ + nanos?: number | null; + /** + * Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone, e.g. "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number, e.g. "2019a". + */ + version?: string | null; + } + /** + * Represents one week day in a month. An example is "the 4th Sunday". + */ + export interface Schema$WeekDayOfMonth { + /** + * Required. A day of the week. + */ + dayOfWeek?: string | null; + /** + * Required. Week number in a month. 1-4 indicates the 1st to 4th week of the month. -1 indicates the last week of the month. + */ + weekOrdinal?: number | null; + } + /** + * Represents a weekly schedule. + */ + export interface Schema$WeeklySchedule { + /** + * Required. Day of the week. + */ + dayOfWeek?: string | null; + } + /** + * Windows patching is performed using the Windows Update Agent. + */ + export interface Schema$WindowsUpdateSettings { + /** + * Only apply updates of these windows update classifications. If empty, all updates are applied. + */ + classifications?: string[] | null; + /** + * List of KBs to exclude from update. + */ + excludes?: string[] | null; + /** + * An exclusive list of kbs to be updated. These are the only patches that will be updated. This field must not be used with other patch configurations. + */ + exclusivePatches?: string[] | null; + } + /** + * Represents a single Yum package repository. This repository is added to a repo file that is stored at `/etc/yum.repos.d/google_osconfig.repo`. + */ + export interface Schema$YumRepository { + /** + * Required. The location of the repository directory. + */ + baseUrl?: string | null; + /** + * The display name of the repository. + */ + displayName?: string | null; + /** + * URIs of GPG keys. + */ + gpgKeys?: string[] | null; + /** + * Required. A one word, unique name for this repository. This is the `repo id` in the Yum config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. + */ + id?: string | null; + } + /** + * Yum patching is performed by executing `yum update`. Additional options can be set to control how this is executed. Note that not all settings are supported on all platforms. + */ + export interface Schema$YumSettings { + /** + * List of packages to exclude from update. These packages are excluded by using the yum `--exclude` flag. + */ + excludes?: string[] | null; + /** + * An exclusive list of packages to be updated. These are the only packages that will be updated. If these packages are not installed, they will be ignored. This field must not be specified with any other patch configuration fields. + */ + exclusivePackages?: string[] | null; + /** + * Will cause patch to run `yum update-minimal` instead. + */ + minimal?: boolean | null; + /** + * Adds the `--security` flag to `yum update`. Not supported on all platforms. + */ + security?: boolean | null; + } + /** + * Represents a single Zypper package repository. This repository is added to a repo file that is stored at `/etc/zypp/repos.d/google_osconfig.repo`. + */ + export interface Schema$ZypperRepository { + /** + * Required. The location of the repository directory. + */ + baseUrl?: string | null; + /** + * The display name of the repository. + */ + displayName?: string | null; + /** + * URIs of GPG keys. + */ + gpgKeys?: string[] | null; + /** + * Required. A one word, unique name for this repository. This is the `repo id` in the zypper config file and also the `display_name` if `display_name` is omitted. This id is also used as the unique identifier when checking for guest policy conflicts. + */ + id?: string | null; + } + /** + * Zypper patching is performed by running `zypper patch`. See also https://en.opensuse.org/SDB:Zypper_manual. + */ + export interface Schema$ZypperSettings { + /** + * Install only patches with these categories. Common categories include security, recommended, and feature. + */ + categories?: string[] | null; + /** + * List of patches to exclude from update. + */ + excludes?: string[] | null; + /** + * An exclusive list of patches to be updated. These are the only patches that will be installed using 'zypper patch patch:<patch_name>' command. This field must not be used with any other patch configuration fields. + */ + exclusivePatches?: string[] | null; + /** + * Install only patches with these severities. Common severities include critical, important, moderate, and low. + */ + severities?: string[] | null; + /** + * Adds the `--with-optional` flag to `zypper patch`. + */ + withOptional?: boolean | null; + /** + * Adds the `--with-update` flag, to `zypper patch`. + */ + withUpdate?: boolean | null; + } + + export class Resource$Projects { + context: APIRequestContext; + guestPolicies: Resource$Projects$Guestpolicies; + patchDeployments: Resource$Projects$Patchdeployments; + patchJobs: Resource$Projects$Patchjobs; + zones: Resource$Projects$Zones; + constructor(context: APIRequestContext) { + this.context = context; + this.guestPolicies = new Resource$Projects$Guestpolicies(this.context); + this.patchDeployments = new Resource$Projects$Patchdeployments( + this.context + ); + this.patchJobs = new Resource$Projects$Patchjobs(this.context); + this.zones = new Resource$Projects$Zones(this.context); + } + } + + export class Resource$Projects$Guestpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * osconfig.projects.guestPolicies.create + * @desc Create an OS Config guest policy. + * @alias osconfig.projects.guestPolicies.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.guestPolicyId Required. The logical name of the guest policy in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. + * @param {string} params.parent Required. The resource name of the parent using one of the following forms: `projects/{project_number}`. + * @param {().GuestPolicy} params.requestBody Request 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$Guestpolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Guestpolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Guestpolicies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Guestpolicies$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Guestpolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Guestpolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/guestPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.guestPolicies.delete + * @desc Delete an OS Config guest policy. + * @alias osconfig.projects.guestPolicies.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_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$Guestpolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Guestpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Guestpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Guestpolicies$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Guestpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Guestpolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.guestPolicies.get + * @desc Get an OS Config guest policy. + * @alias osconfig.projects.guestPolicies.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_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$Guestpolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Guestpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Guestpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Guestpolicies$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Guestpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Guestpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.guestPolicies.list + * @desc Get a page of OS Config guest policies. + * @alias osconfig.projects.guestPolicies.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of guest policies to return. + * @param {string=} params.pageToken A pagination token returned from a previous call to `ListGuestPolicies` that indicates where this listing should continue from. + * @param {string} params.parent Required. The resource name of the parent using one of the following forms: `projects/{project_number}`. + * @param {object} [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$Guestpolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Guestpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Guestpolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Guestpolicies$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Guestpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Guestpolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/guestPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.guestPolicies.patch + * @desc Update an OS Config guest policy. + * @alias osconfig.projects.guestPolicies.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. + * @param {string=} params.updateMask Field mask that controls which fields of the guest policy should be updated. + * @param {().GuestPolicy} params.requestBody Request 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$Guestpolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Guestpolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Guestpolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Guestpolicies$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Guestpolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Guestpolicies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+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$Guestpolicies$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The logical name of the guest policy in the project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. + */ + guestPolicyId?: string; + /** + * Required. The resource name of the parent using one of the following forms: `projects/{project_number}`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GuestPolicy; + } + export interface Params$Resource$Projects$Guestpolicies$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Guestpolicies$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the guest policy using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Guestpolicies$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of guest policies to return. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call to `ListGuestPolicies` that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The resource name of the parent using one of the following forms: `projects/{project_number}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Guestpolicies$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Unique name of the resource in this project using one of the following forms: `projects/{project_number}/guestPolicies/{guest_policy_id}`. + */ + name?: string; + /** + * Field mask that controls which fields of the guest policy should be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GuestPolicy; + } + + export class Resource$Projects$Patchdeployments { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * osconfig.projects.patchDeployments.create + * @desc Create an OS Config patch deployment. + * @alias osconfig.projects.patchDeployments.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project to apply this patch deployment to in the form `projects/x`. + * @param {string=} params.patchDeploymentId Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. + * @param {().PatchDeployment} params.requestBody Request 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$Patchdeployments$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Patchdeployments$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Patchdeployments$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Patchdeployments$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchdeployments$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchdeployments$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/patchDeployments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.patchDeployments.delete + * @desc Delete an OS Config patch deployment. + * @alias osconfig.projects.patchDeployments.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the patch deployment in the form `projects/x/patchDeployments/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 + */ + delete( + params?: Params$Resource$Projects$Patchdeployments$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Patchdeployments$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Patchdeployments$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Patchdeployments$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchdeployments$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchdeployments$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.patchDeployments.get + * @desc Get an OS Config patch deployment. + * @alias osconfig.projects.patchDeployments.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the patch deployment in the form `projects/x/patchDeployments/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 + */ + get( + params?: Params$Resource$Projects$Patchdeployments$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Patchdeployments$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Patchdeployments$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Patchdeployments$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchdeployments$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchdeployments$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.patchDeployments.list + * @desc Get a page of OS Config patch deployments. + * @alias osconfig.projects.patchDeployments.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of patch deployments to return. Default is 100. + * @param {string=} params.pageToken Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from. + * @param {string} params.parent Required. The resource name of the parent in the form `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$Patchdeployments$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Patchdeployments$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Patchdeployments$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Patchdeployments$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchdeployments$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchdeployments$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/patchDeployments').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$Patchdeployments$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The project to apply this patch deployment to in the form `projects/x`. + */ + parent?: string; + /** + * Required. A name for the patch deployment in the project. When creating a name the following rules apply: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the project. + */ + patchDeploymentId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PatchDeployment; + } + export interface Params$Resource$Projects$Patchdeployments$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the patch deployment in the form `projects/x/patchDeployments/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Patchdeployments$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the patch deployment in the form `projects/x/patchDeployments/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Patchdeployments$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of patch deployments to return. Default is 100. + */ + pageSize?: number; + /** + * Optional. A pagination token returned from a previous call to ListPatchDeployments that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The resource name of the parent in the form `projects/x`. + */ + parent?: string; + } + + export class Resource$Projects$Patchjobs { + context: APIRequestContext; + instanceDetails: Resource$Projects$Patchjobs$Instancedetails; + constructor(context: APIRequestContext) { + this.context = context; + this.instanceDetails = new Resource$Projects$Patchjobs$Instancedetails( + this.context + ); + } + + /** + * osconfig.projects.patchJobs.cancel + * @desc Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted. + * @alias osconfig.projects.patchJobs.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the patch in the form `projects/x/patchJobs/x` + * @param {().CancelPatchJobRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel( + params?: Params$Resource$Projects$Patchjobs$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Patchjobs$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Patchjobs$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Patchjobs$Cancel + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchjobs$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchjobs$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.patchJobs.execute + * @desc Patch VM instances by creating and running a patch job. + * @alias osconfig.projects.patchJobs.execute + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project in which to run this patch in the form `projects/x` + * @param {().ExecutePatchJobRequest} params.requestBody Request 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 + */ + execute( + params?: Params$Resource$Projects$Patchjobs$Execute, + options?: MethodOptions + ): GaxiosPromise; + execute( + params: Params$Resource$Projects$Patchjobs$Execute, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + execute( + params: Params$Resource$Projects$Patchjobs$Execute, + callback: BodyResponseCallback + ): void; + execute(callback: BodyResponseCallback): void; + execute( + paramsOrCallback?: + | Params$Resource$Projects$Patchjobs$Execute + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchjobs$Execute; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchjobs$Execute; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/patchJobs:execute').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.patchJobs.get + * @desc Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs. + * @alias osconfig.projects.patchJobs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the patch in the form `projects/x/patchJobs/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 + */ + get( + params?: Params$Resource$Projects$Patchjobs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Patchjobs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Patchjobs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Patchjobs$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchjobs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchjobs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * osconfig.projects.patchJobs.list + * @desc Get a list of patch jobs. + * @alias osconfig.projects.patchJobs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field. + * @param {integer=} params.pageSize The maximum number of instance status to return. + * @param {string=} params.pageToken A pagination token returned from a previous call that indicates where this listing should continue from. + * @param {string} params.parent Required. In the form of `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$Patchjobs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Patchjobs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Patchjobs$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Patchjobs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchjobs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchjobs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/patchJobs').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$Patchjobs$Cancel + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the patch in the form `projects/x/patchJobs/x` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelPatchJobRequest; + } + export interface Params$Resource$Projects$Patchjobs$Execute + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The project in which to run this patch in the form `projects/x` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ExecutePatchJobRequest; + } + export interface Params$Resource$Projects$Patchjobs$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the patch in the form `projects/x/patchJobs/x` + */ + name?: string; + } + export interface Params$Resource$Projects$Patchjobs$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field. + */ + filter?: string; + /** + * The maximum number of instance status to return. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. In the form of `projects/x` + */ + parent?: string; + } + + export class Resource$Projects$Patchjobs$Instancedetails { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * osconfig.projects.patchJobs.instanceDetails.list + * @desc Get a list of instance details for a given patch job. + * @alias osconfig.projects.patchJobs.instanceDetails.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`. + * @param {integer=} params.pageSize The maximum number of instance details records to return. Default is 100. + * @param {string=} params.pageToken A pagination token returned from a previous call that indicates where this listing should continue from. + * @param {string} params.parent Required. The parent for the instances are in the form of `projects/x/patchJobs/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$Patchjobs$Instancedetails$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Patchjobs$Instancedetails$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Patchjobs$Instancedetails$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Patchjobs$Instancedetails$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$ListPatchJobInstanceDetailsResponse + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Patchjobs$Instancedetails$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Patchjobs$Instancedetails$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/instanceDetails').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$Patchjobs$Instancedetails$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or `failure_reason`. + */ + filter?: string; + /** + * The maximum number of instance details records to return. Default is 100. + */ + pageSize?: number; + /** + * A pagination token returned from a previous call that indicates where this listing should continue from. + */ + pageToken?: string; + /** + * Required. The parent for the instances are in the form of `projects/x/patchJobs/x`. + */ + parent?: string; + } + + export class Resource$Projects$Zones { + context: APIRequestContext; + instances: Resource$Projects$Zones$Instances; + constructor(context: APIRequestContext) { + this.context = context; + this.instances = new Resource$Projects$Zones$Instances(this.context); + } + } + + export class Resource$Projects$Zones$Instances { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * osconfig.projects.zones.instances.lookupEffectiveGuestPolicy + * @desc Lookup the effective guest policy that applies to a VM instance. This lookup merges all policies that are assigned to the instance ancestry. + * @alias osconfig.projects.zones.instances.lookupEffectiveGuestPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Required. The VM instance whose policies are being looked up. + * @param {().LookupEffectiveGuestPolicyRequest} params.requestBody Request 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 + */ + lookupEffectiveGuestPolicy( + params?: Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy, + options?: MethodOptions + ): GaxiosPromise; + lookupEffectiveGuestPolicy( + params: Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupEffectiveGuestPolicy( + params: Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy, + callback: BodyResponseCallback + ): void; + lookupEffectiveGuestPolicy( + callback: BodyResponseCallback + ): void; + lookupEffectiveGuestPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://osconfig.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta/{+instance}:lookupEffectiveGuestPolicy' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['instance'], + pathParams: ['instance'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Zones$Instances$Lookupeffectiveguestpolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The VM instance whose policies are being looked up. + */ + instance?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LookupEffectiveGuestPolicyRequest; + } +} diff --git a/src/apis/plusDomains/webpack.config.js b/src/apis/osconfig/webpack.config.js similarity index 96% rename from src/apis/plusDomains/webpack.config.js rename to src/apis/osconfig/webpack.config.js index 0d02eb4e77..9c2e938c5c 100644 --- a/src/apis/plusDomains/webpack.config.js +++ b/src/apis/osconfig/webpack.config.js @@ -22,8 +22,8 @@ module.exports = { extensions: ['.ts', '.js', '.json'], }, output: { - library: 'Plusdomains', - filename: 'plusDomains.min.js', + library: 'Osconfig', + filename: 'osconfig.min.js', path: path.resolve(__dirname, 'dist'), }, node: { diff --git a/src/apis/oslogin/v1.ts b/src/apis/oslogin/v1.ts index 73486cc73b..fe48359ef5 100644 --- a/src/apis/oslogin/v1.ts +++ b/src/apis/oslogin/v1.ts @@ -89,7 +89,7 @@ export namespace oslogin_v1 { /** * Cloud OS Login API * - * You can use OS Login to manage access to your VM instances using IAM roles. For more information, read [OS Login](/compute/docs/oslogin/). + * You can use OS Login to manage access to your VM instances using IAM roles. * * @example * const {google} = require('googleapis'); diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index e0262968e6..7d26ceaa98 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -89,7 +89,7 @@ export namespace oslogin_v1alpha { /** * Cloud OS Login API * - * You can use OS Login to manage access to your VM instances using IAM roles. For more information, read [OS Login](/compute/docs/oslogin/). + * You can use OS Login to manage access to your VM instances using IAM roles. * * @example * const {google} = require('googleapis'); diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index 06e2ddac33..5f3116e151 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -89,7 +89,7 @@ export namespace oslogin_v1beta { /** * Cloud OS Login API * - * You can use OS Login to manage access to your VM instances using IAM roles. For more information, read [OS Login](/compute/docs/oslogin/). + * You can use OS Login to manage access to your VM instances using IAM roles. * * @example * const {google} = require('googleapis'); diff --git a/src/apis/pagespeedonline/v5.ts b/src/apis/pagespeedonline/v5.ts index 3bdc7e0a0b..5e7628432f 100644 --- a/src/apis/pagespeedonline/v5.ts +++ b/src/apis/pagespeedonline/v5.ts @@ -41,9 +41,21 @@ export namespace pagespeedonline_v5 { interface StandardParameters { /** - * Data format for the response. + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. */ alt?: string; + /** + * JSONP + */ + callback?: string; /** * Selector specifying which fields to include in a partial response. */ @@ -61,19 +73,23 @@ export namespace pagespeedonline_v5 { */ prettyPrint?: boolean; /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. + * Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */ quotaUser?: string; /** - * Deprecated. Please use quotaUser instead. + * Legacy upload protocol for media (e.g. "media", "multipart"). */ - userIp?: string; + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; } /** * PageSpeed Insights API * - * Analyzes the performance of a web page and provides tailored suggestions to make that page faster. + * The PageSpeed Insights API lets you analyze the performance of your website with a simple API. It offers tailored suggestions for how you can optimize your site, and lets you easily integrate PageSpeed Insights analysis into your development tools and workflow. * * @example * const {google} = require('googleapis'); @@ -99,8 +115,128 @@ export namespace pagespeedonline_v5 { } } - export interface Schema$GoogleprotobufListValue {} - export interface Schema$GoogleprotobufValue {} + /** + * A light reference to an audit by id, used to group and weight audits in a given category. + */ + export interface Schema$AuditRefs { + /** + * The category group that the audit belongs to (optional). + */ + group?: string | null; + /** + * The audit ref id. + */ + id?: string | null; + /** + * The weight this audit's score has on the overall category score. + */ + weight?: number | null; + } + /** + * A proportion of data in the total distribution, bucketed by a min/max percentage. Each bucket's range is bounded by min <= x < max, In millisecond. + */ + export interface Schema$Bucket { + /** + * Upper bound for a bucket's range. + */ + max?: number | null; + /** + * Lower bound for a bucket's range. + */ + min?: number | null; + /** + * The proportion of data in this bucket. + */ + proportion?: number | null; + } + /** + * The categories in a Lighthouse run. + */ + export interface Schema$Categories { + /** + * The accessibility category, containing all accessibility related audits. + */ + accessibility?: Schema$LighthouseCategoryV5; + /** + * The best practices category, containing all best practices related audits. + */ + 'best-practices'?: Schema$LighthouseCategoryV5; + /** + * The performance category, containing all performance related audits. + */ + performance?: Schema$LighthouseCategoryV5; + /** + * The Progressive-Web-App (PWA) category, containing all pwa related audits. + */ + pwa?: Schema$LighthouseCategoryV5; + /** + * The Search-Engine-Optimization (SEO) category, containing all seo related audits. + */ + seo?: Schema$LighthouseCategoryV5; + } + /** + * Message containing a category + */ + export interface Schema$CategoryGroupV5 { + /** + * The description of what the category is grouping + */ + description?: string | null; + /** + * The human readable title of the group + */ + title?: string | null; + } + /** + * Message containing the configuration settings for the Lighthouse run. + */ + export interface Schema$ConfigSettings { + /** + * How Lighthouse was run, e.g. from the Chrome extension or from the npm module. + */ + channel?: string | null; + /** + * The form factor the emulation should use. + */ + emulatedFormFactor?: string | null; + /** + * The locale setting. + */ + locale?: string | null; + /** + * List of categories of audits the run should conduct. + */ + onlyCategories?: any | null; + } + /** + * Message containing environment configuration for a Lighthouse run. + */ + export interface Schema$Environment { + /** + * The benchmark index number that indicates rough device class. + */ + benchmarkIndex?: number | null; + /** + * The user agent string of the version of Chrome used. + */ + hostUserAgent?: string | null; + /** + * The user agent string that was sent over the network. + */ + networkUserAgent?: string | null; + } + /** + * Message containing the i18n data for the LHR - Version 1. + */ + export interface Schema$I18n { + /** + * Internationalized strings that are formatted to the locale in configSettings. + */ + rendererFormattedStrings?: Schema$RendererFormattedStrings; + } + /** + * An audit's result object in a Lighthouse result. + */ export interface Schema$LighthouseAuditResultV5 { /** * The description of the audit. @@ -130,6 +266,9 @@ export namespace pagespeedonline_v5 { * A numeric value that has a meaning specific to the audit, e.g. the number of nodes in the DOM or the timestamp of a specific load event. More information can be found in the audit details, if present. */ numericValue?: number | null; + /** + * The score of the audit, can be null. + */ score?: any | null; /** * The enumerated score display mode. @@ -139,13 +278,19 @@ export namespace pagespeedonline_v5 { * The human readable title. */ title?: string | null; + /** + * Possible warnings that occurred in the audit, can be null. + */ warnings?: any | null; } + /** + * A Lighthouse category. + */ export interface Schema$LighthouseCategoryV5 { /** * An array of references to all the audit members of this category. */ - auditRefs?: Array<{group?: string; id?: string; weight?: number}> | null; + auditRefs?: Schema$AuditRefs[]; /** * A more detailed description of the category and its importance. */ @@ -158,12 +303,18 @@ export namespace pagespeedonline_v5 { * A description for the manual audits in the category. */ manualDescription?: string | null; + /** + * The overall score of the category, the weighted average of all its audits. (The category's score, can be null.) + */ score?: any | null; /** * The human-friendly name of the category. */ title?: string | null; } + /** + * The Lighthouse result object. + */ export interface Schema$LighthouseResultV5 { /** * Map of audits in the LHR. @@ -172,35 +323,19 @@ export namespace pagespeedonline_v5 { /** * Map of categories in the LHR. */ - categories?: { - accessibility?: Schema$LighthouseCategoryV5; - 'best-practices'?: Schema$LighthouseCategoryV5; - performance?: Schema$LighthouseCategoryV5; - pwa?: Schema$LighthouseCategoryV5; - seo?: Schema$LighthouseCategoryV5; - } | null; + categories?: Schema$Categories; /** * Map of category groups in the LHR. */ - categoryGroups?: { - [key: string]: {description?: string; title?: string}; - } | null; + categoryGroups?: {[key: string]: Schema$CategoryGroupV5} | null; /** * The configuration settings for this LHR. */ - configSettings?: { - emulatedFormFactor?: string; - locale?: string; - onlyCategories?: any; - } | null; + configSettings?: Schema$ConfigSettings; /** * Environment settings that were used when making this LHR. */ - environment?: { - benchmarkIndex?: number; - hostUserAgent?: string; - networkUserAgent?: string; - } | null; + environment?: Schema$Environment; /** * The time that this run was fetched. */ @@ -212,26 +347,7 @@ export namespace pagespeedonline_v5 { /** * The internationalization strings that are required to render the LHR. */ - i18n?: { - rendererFormattedStrings?: { - auditGroupExpandTooltip?: string; - crcInitialNavigation?: string; - crcLongestDurationLabel?: string; - errorLabel?: string; - errorMissingAuditInfo?: string; - labDataTitle?: string; - lsPerformanceCategoryDescription?: string; - manualAuditsGroupTitle?: string; - notApplicableAuditsGroupTitle?: string; - opportunityResourceColumnLabel?: string; - opportunitySavingsColumnLabel?: string; - passedAuditsGroupTitle?: string; - scorescaleLabel?: string; - toplevelWarningsMessage?: string; - varianceDisclaimer?: string; - warningHeader?: string; - }; - } | null; + i18n?: Schema$I18n; /** * The lighthouse version that was used to generate this LHR. */ @@ -243,48 +359,48 @@ export namespace pagespeedonline_v5 { /** * A top-level error message that, if present, indicates a serious enough problem that this Lighthouse result may need to be discarded. */ - runtimeError?: {code?: string; message?: string} | null; + runtimeError?: Schema$RuntimeError; /** - * List of all run warnings in the LHR. Will always output to at least `[]`. + * List of all run warnings in the LHR. Will always output to at least `[]`. */ - runWarnings?: Schema$GoogleprotobufListValue; + runWarnings?: any[] | null; /** * The Stack Pack advice strings. */ - stackPacks?: Array<{ - descriptions?: {[key: string]: string}; - iconDataURL?: string; - id?: string; - title?: string; - }> | null; + stackPacks?: Schema$StackPack[]; /** * Timing information for this LHR. */ - timing?: {total?: number} | null; + timing?: Schema$Timing; /** * The user agent that was used to run this LHR. */ userAgent?: string | null; } + /** + * The CrUX loading experience object that contains CrUX data breakdowns. + */ export interface Schema$PagespeedApiLoadingExperienceV5 { /** * The url, pattern or origin which the metrics are on. */ id?: string | null; + /** + * The requested URL, which may differ from the resolved "id". + */ initial_url?: string | null; - metrics?: { - [key: string]: { - category?: string; - distributions?: Array<{ - max?: number; - min?: number; - proportion?: number; - }>; - percentile?: number; - }; - } | null; + /** + * The map of <metrics, data>. + */ + metrics?: {[key: string]: Schema$UserPageLoadMetricV5} | null; + /** + * The human readable speed "category" of the id. + */ overall_category?: string | null; } + /** + * The Pagespeed API response object. + */ export interface Schema$PagespeedApiPagespeedResponseV5 { /** * The UTC timestamp of this analysis. @@ -317,7 +433,161 @@ export namespace pagespeedonline_v5 { /** * The version of PageSpeed used to generate these results. */ - version?: {major?: number; minor?: number} | null; + version?: Schema$PagespeedVersion; + } + /** + * The Pagespeed Version object. + */ + export interface Schema$PagespeedVersion { + /** + * The major version number of PageSpeed used to generate these results. + */ + major?: string | null; + /** + * The minor version number of PageSpeed used to generate these results. + */ + minor?: string | null; + } + /** + * Message holding the formatted strings used in the renderer. + */ + export interface Schema$RendererFormattedStrings { + /** + * The tooltip text on an expandable chevron icon. + */ + auditGroupExpandTooltip?: string | null; + /** + * The label for the initial request in a critical request chain. + */ + crcInitialNavigation?: string | null; + /** + * The label for values shown in the summary of critical request chains. + */ + crcLongestDurationLabel?: string | null; + /** + * The label shown next to an audit or metric that has had an error. + */ + errorLabel?: string | null; + /** + * The error string shown next to an erroring audit. + */ + errorMissingAuditInfo?: string | null; + /** + * The title of the lab data performance category. + */ + labDataTitle?: string | null; + /** + * The disclaimer shown under performance explaning that the network can vary. + */ + lsPerformanceCategoryDescription?: string | null; + /** + * The heading shown above a list of audits that were not computerd in the run. + */ + manualAuditsGroupTitle?: string | null; + /** + * The heading shown above a list of audits that do not apply to a page. + */ + notApplicableAuditsGroupTitle?: string | null; + /** + * The heading for the estimated page load savings opportunity of an audit. + */ + opportunityResourceColumnLabel?: string | null; + /** + * The heading for the estimated page load savings of opportunity audits. + */ + opportunitySavingsColumnLabel?: string | null; + /** + * The heading that is shown above a list of audits that are passing. + */ + passedAuditsGroupTitle?: string | null; + /** + * The label that explains the score gauges scale (0-49, 50-89, 90-100). + */ + scorescaleLabel?: string | null; + /** + * The label shown preceding important warnings that may have invalidated an entire report. + */ + toplevelWarningsMessage?: string | null; + /** + * The disclaimer shown below a performance metric value. + */ + varianceDisclaimer?: string | null; + /** + * The label shown above a bulleted list of warnings. + */ + warningHeader?: string | null; + } + /** + * Message containing a runtime error config. + */ + export interface Schema$RuntimeError { + /** + * The enumerated Lighthouse Error code. + */ + code?: string | null; + /** + * A human readable message explaining the error code. + */ + message?: string | null; + } + /** + * Message containing Stack Pack information. + */ + export interface Schema$StackPack { + /** + * The stack pack advice strings. + */ + descriptions?: {[key: string]: string} | null; + /** + * The stack pack icon data uri. + */ + iconDataURL?: string | null; + /** + * The stack pack id. + */ + id?: string | null; + /** + * The stack pack title. + */ + title?: string | null; + } + /** + * Message containing the performance timing data for the Lighthouse run. + */ + export interface Schema$Timing { + /** + * The total duration of Lighthouse's run. + */ + total?: number | null; + } + /** + * A CrUX metric object for a single metric and form factor. + */ + export interface Schema$UserPageLoadMetricV5 { + /** + * The category of the specific time metric. + */ + category?: string | null; + /** + * Metric distributions. Proportions should sum up to 1. + */ + distributions?: Schema$Bucket[]; + /** + * Identifies the form factor of the metric being collected. + */ + formFactor?: string | null; + /** + * The median number of the metric, in millisecond. + */ + median?: number | null; + /** + * Identifies the type of the metric. + */ + metricId?: string | null; + /** + * We use this field to store certain percentile value for this metric. For v4, this field contains pc50. For v5, this field contains pc90. + */ + percentile?: number | null; } export class Resource$Pagespeedapi { @@ -333,10 +603,11 @@ export namespace pagespeedonline_v5 { * @memberOf! () * * @param {object} params Parameters for request + * @param {string=} params.captchaToken The captcha token passed when filling out a captcha. * @param {string=} params.category A Lighthouse category to run; if none are given, only Performance category will be run * @param {string=} params.locale The locale used to localize formatted results * @param {string=} params.strategy The analysis strategy (desktop or mobile) to use, and desktop is the default - * @param {string} params.url The URL to fetch and analyze + * @param {string=} params.url The URL to fetch and analyze * @param {string=} params.utm_campaign Campaign name for analytics. * @param {string=} params.utm_source Campaign source for analytics. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -385,7 +656,8 @@ export namespace pagespeedonline_v5 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = + options.rootUrl || 'https://pagespeedonline.googleapis.com/'; const parameters = { options: Object.assign( { @@ -398,7 +670,7 @@ export namespace pagespeedonline_v5 { options ), params, - requiredParams: ['url'], + requiredParams: [], pathParams: [], context: this.context, }; @@ -422,6 +694,10 @@ export namespace pagespeedonline_v5 { */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + /** + * The captcha token passed when filling out a captcha. + */ + captchaToken?: string; /** * A Lighthouse category to run; if none are given, only Performance category will be run */ diff --git a/src/apis/people/v1.ts b/src/apis/people/v1.ts index 240d665975..8937398df0 100644 --- a/src/apis/people/v1.ts +++ b/src/apis/people/v1.ts @@ -272,7 +272,7 @@ export namespace people_v1 { */ name?: string | null; /** - * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`<var>contact_group_id</var>. + * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. */ resourceName?: string | null; } @@ -285,7 +285,7 @@ export namespace people_v1 { */ contactGroupId?: string | null; /** - * 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. + * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. 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 | null; } @@ -464,6 +464,9 @@ export namespace people_v1 { */ value?: string | null; } + /** + * The response to a get request for a list of people by resource name. + */ export interface Schema$GetPeopleResponse { /** * The response for each requested resource name. @@ -512,6 +515,9 @@ export namespace people_v1 { */ value?: string | null; } + /** + * The response to a request for the authenticated user's connections. + */ export interface Schema$ListConnectionsResponse { /** * The list of people that the requestor is connected to. @@ -590,11 +596,11 @@ export namespace people_v1 { */ export interface Schema$ModifyContactGroupMembersRequest { /** - * The resource names of the contact people to add in the form of `people/`<var>person_id</var>. + * Optional. The resource names of the contact people to add in the form of `people/{person_id}`. */ resourceNamesToAdd?: string[] | null; /** - * The resource names of the contact people to remove in the form of `people/`<var>person_id</var>. + * Optional. The resource names of the contact people to remove in the form of `people/{person_id}`. */ resourceNamesToRemove?: string[] | null; } @@ -772,7 +778,7 @@ export namespace people_v1 { */ addresses?: Schema$Address[]; /** - * Output only. **DEPRECATED** (Please use `person.ageRanges` instead)** The person's age range. + * Output only. **DEPRECATED** (Please use `person.ageRanges` instead) The person's age range. */ ageRange?: string | null; /** @@ -872,7 +878,7 @@ export namespace people_v1 { */ residences?: Schema$Residence[]; /** - * 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/`<var>person_id</var>. + * 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}`. */ resourceName?: string | null; /** @@ -980,7 +986,7 @@ export namespace people_v1 { */ metadata?: Schema$FieldMetadata; /** - * The URL of the photo. You can change the desired size by appending a query parameter `sz=`<var>size</var> at the end of the url. Example: `https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50` + * The URL of the photo. You can change the desired size by appending a query parameter `sz={size}` at the end of the url, where {size} is the size in pixels. Example: https://lh3.googleusercontent.com/-T_wVWLlmg7w/AAAAAAAAAAI/AAAAAAAABa8/00gzXvDBYqw/s100/photo.jpg?sz=50 */ url?: string | null; } @@ -1547,8 +1553,8 @@ export namespace people_v1 { * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The maximum number of resources to return. Valid values are between 1 and 1000, inclusive. Defaults to 30 if not set or set to 0. - * @param {string=} params.pageToken The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources. - * @param {string=} params.syncToken A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned. + * @param {string=} params.pageToken Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources. + * @param {string=} params.syncToken Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be 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 @@ -1626,7 +1632,7 @@ export namespace people_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.resourceName The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`contact_group_id. + * @param {string} params.resourceName The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. * @param {().UpdateContactGroupRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1767,11 +1773,11 @@ export namespace people_v1 { */ pageSize?: number; /** - * The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources. + * Optional. The next_page_token value returned from a previous call to [ListContactGroups](/people/api/rest/v1/contactgroups/list). Requests the next page of resources. */ pageToken?: string; /** - * A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned. + * Optional. A sync token, returned by a previous call to `contactgroups.list`. Only resources changed since the sync token was created will be returned. */ syncToken?: string; } @@ -1783,7 +1789,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/`contact_group_id. + * The resource name for the contact group, assigned by the server. An ASCII string, in the form of `contactGroups/{contact_group_id}`. */ resourceName?: string; @@ -1801,7 +1807,7 @@ export namespace people_v1 { /** * people.contactGroups.members.modify - * @desc Modify the members of a contact group owned by the authenticated user.
                          The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed. + * @desc Modify the members of a contact group owned by the authenticated user. The only system contact groups that can have members added are `contactGroups/myContacts` and `contactGroups/starred`. Other system contact groups are deprecated and can only have contacts removed. * @alias people.contactGroups.members.modify * @memberOf! () * @@ -2138,14 +2144,14 @@ export namespace people_v1 { /** * people.people.get - * @desc Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user.
                          The request throws a 400 error if 'personFields' is not specified. + * @desc Provides information about a person by specifying a resource name. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified. * @alias people.people.get * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.personFields Required. A field mask to restrict which fields on the person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined * @param {string=} params.requestMask.includeField Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. - * @param {string} params.resourceName Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). + * @param {string} params.resourceName Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/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 @@ -2211,14 +2217,14 @@ export namespace people_v1 { /** * people.people.getBatchGet - * @desc Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user.
                          The request throws a 400 error if 'personFields' is not specified. + * @desc Provides information about a list of specific people by specifying a list of requested resource names. Use `people/me` to indicate the authenticated user. The request throws a 400 error if 'personFields' is not specified. * @alias people.people.getBatchGet * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined * @param {string=} params.requestMask.includeField Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. - * @param {string=} params.resourceNames Required. The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request. + * @param {string=} params.resourceNames Required. The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one 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 @@ -2287,12 +2293,12 @@ export namespace people_v1 { /** * people.people.updateContact - * @desc Update contact data for an existing contact person. Any non-contact data will not be modified. The request throws a 400 error if `updatePersonFields` is not specified.
                          The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated.
                          The request throws a 400 error with an error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and re-apply their updates to the latest person. + * @desc Update contact data for an existing contact person. Any non-contact data will not be modified. The request throws a 400 error if `updatePersonFields` is not specified. The request throws a 400 error if `person.metadata.sources` is not specified for the contact to be updated. The request throws a 400 error with an error with reason `"failedPrecondition"` if `person.metadata.sources.etag` is different than the contact's etag, which indicates the contact has changed since its data was read. Clients should get the latest person and re-apply their updates to the latest person. * @alias people.people.updateContact * @memberOf! () * * @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.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 * memberships * names * nicknames * occupations * organizations * phoneNumbers * relations * residences * sipAddresses * urls * userDefined * @param {().Person} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2497,7 +2503,7 @@ export namespace people_v1 { */ 'requestMask.includeField'?: string; /** - * Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). + * Required. The resource name of the person to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). */ resourceName?: string; } @@ -2517,7 +2523,7 @@ export namespace people_v1 { */ 'requestMask.includeField'?: string; /** - * Required. The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/`account_id. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request. + * Required. The resource names of the people to provide information about. - To get information about the authenticated user, specify `people/me`. - To get information about a google account, specify `people/{account_id}`. - To get information about a contact, specify the resource name that identifies the contact as returned by [`people.connections.list`](/people/api/rest/v1/people.connections/list). You can include up to 50 resource names in one request. */ resourceNames?: string[]; } @@ -2529,7 +2535,7 @@ export namespace people_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * 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. + * 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}`. */ resourceName?: string; /** @@ -2568,19 +2574,19 @@ export namespace people_v1 { /** * people.people.connections.list - * @desc Provides a list of the authenticated user's contacts merged with any connected profiles.
                          The request throws a 400 error if 'personFields' is not specified. + * @desc Provides a list of the authenticated user's contacts merged with any connected profiles. The request throws a 400 error if 'personFields' is not specified. * @alias people.people.connections.list * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.pageSize Optional. The number of connections to include in the response. Valid values are between 1 and 2000, inclusive. Defaults to 100 if not set or set to 0. - * @param {string=} params.pageToken The token of the page to be returned. + * @param {string=} params.pageToken Optional. The token of the page to be returned. * @param {string=} params.personFields Required. A field mask to restrict which fields on each person are returned. Multiple fields can be specified by separating them with commas. Valid values are: * addresses * ageRanges * biographies * birthdays * braggingRights * coverPhotos * emailAddresses * events * genders * imClients * interests * locales * memberships * metadata * names * nicknames * occupations * organizations * phoneNumbers * photos * relations * relationshipInterests * relationshipStatuses * residences * sipAddresses * skills * taglines * urls * userDefined * @param {string=} params.requestMask.includeField Required. Comma-separated list of person fields to be included in the response. Each path should start with `person.`: for example, `person.names` or `person.photos`. - * @param {boolean=} params.requestSyncToken Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit. + * @param {boolean=} params.requestSyncToken Optional. Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit. * @param {string} params.resourceName Required. The resource name to return connections for. Only `people/me` is valid. - * @param {string=} params.sortOrder The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`. - * @param {string=} params.syncToken A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit. + * @param {string=} params.sortOrder Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`. + * @param {string=} params.syncToken Optional. A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2662,7 +2668,7 @@ export namespace people_v1 { */ pageSize?: number; /** - * The token of the page to be returned. + * Optional. The token of the page to be returned. */ pageToken?: string; /** @@ -2674,7 +2680,7 @@ export namespace people_v1 { */ 'requestMask.includeField'?: string; /** - * Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit. + * Optional. Whether the response should include a sync token, which can be used to get all changes since the last request. For subsequent sync requests use the `sync_token` param instead. Initial sync requests that specify `request_sync_token` have an additional rate limit. */ requestSyncToken?: boolean; /** @@ -2682,11 +2688,11 @@ export namespace people_v1 { */ resourceName?: string; /** - * The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`. + * Optional. The order in which the connections should be sorted. Defaults to `LAST_MODIFIED_ASCENDING`. */ sortOrder?: string; /** - * A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit. + * Optional. A sync token returned by a previous call to `people.connections.list`. Only resources changed since the sync token was created will be returned. Sync requests that specify `sync_token` have an additional rate limit. */ syncToken?: string; } diff --git a/src/apis/plusDomains/v1.ts b/src/apis/plusDomains/v1.ts deleted file mode 100644 index 3fbdb773f8..0000000000 --- a/src/apis/plusDomains/v1.ts +++ /dev/null @@ -1,1800 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace plusDomains_v1 { - export interface Options extends GlobalOptions { - version: 'v1'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * Google+ Domains API - * - * Builds on top of the Google+ platform for Google Apps Domains. - * - * @example - * const {google} = require('googleapis'); - * const plusDomains = google.plusDomains('v1'); - * - * @namespace plusDomains - * @type {Function} - * @version v1 - * @variation v1 - * @param {object=} options Options for Plusdomains - */ - export class Plusdomains { - context: APIRequestContext; - activities: Resource$Activities; - audiences: Resource$Audiences; - circles: Resource$Circles; - comments: Resource$Comments; - media: Resource$Media; - people: Resource$People; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.activities = new Resource$Activities(this.context); - this.audiences = new Resource$Audiences(this.context); - this.circles = new Resource$Circles(this.context); - this.comments = new Resource$Comments(this.context); - this.media = new Resource$Media(this.context); - this.people = new Resource$People(this.context); - } - } - - export interface Schema$Acl { - /** - * Description of the access granted, suitable for display. - */ - description?: string | null; - /** - * Whether access is restricted to the domain. - */ - domainRestricted?: boolean | null; - /** - * The list of access entries. - */ - items?: Schema$PlusDomainsAclentryResource[]; - /** - * Identifies this resource as a collection of access controls. Value: "plus#acl". - */ - kind?: string | null; - } - export interface Schema$Activity { - /** - * Identifies who has access to see this activity. - */ - access?: Schema$Acl; - /** - * The person who performed this activity. - */ - actor?: { - clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string}}; - displayName?: string; - id?: string; - image?: {url?: string}; - name?: {familyName?: string; givenName?: string}; - url?: string; - verification?: {adHocVerified?: string}; - } | null; - /** - * Street address where this activity occurred. - */ - address?: string | null; - /** - * Additional content added by the person who shared this activity, applicable only when resharing an activity. - */ - annotation?: string | null; - /** - * If this activity is a crosspost from another system, this property specifies the ID of the original activity. - */ - crosspostSource?: string | null; - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * Latitude and longitude where this activity occurred. Format is latitude followed by longitude, space separated. - */ - geocode?: string | null; - /** - * The ID of this activity. - */ - id?: string | null; - /** - * Identifies this resource as an activity. Value: "plus#activity". - */ - kind?: string | null; - /** - * The location where this activity occurred. - */ - location?: Schema$Place; - /** - * The object of this activity. - */ - object?: { - actor?: { - clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string}}; - displayName?: string; - id?: string; - image?: {url?: string}; - url?: string; - verification?: {adHocVerified?: string}; - }; - attachments?: Array<{ - content?: string; - displayName?: string; - embed?: {type?: string; url?: string}; - fullImage?: { - height?: number; - type?: string; - url?: string; - width?: number; - }; - id?: string; - image?: {height?: number; type?: string; url?: string; width?: number}; - objectType?: string; - previewThumbnails?: Array<{url?: string}>; - thumbnails?: Array<{ - description?: string; - image?: { - height?: number; - type?: string; - url?: string; - width?: number; - }; - url?: string; - }>; - url?: string; - }>; - content?: string; - id?: string; - objectType?: string; - originalContent?: string; - plusoners?: {selfLink?: string; totalItems?: number}; - replies?: {selfLink?: string; totalItems?: number}; - resharers?: {selfLink?: string; totalItems?: number}; - statusForViewer?: { - canComment?: boolean; - canPlusone?: boolean; - canUpdate?: boolean; - isPlusOned?: boolean; - resharingDisabled?: boolean; - }; - url?: string; - } | null; - /** - * ID of the place where this activity occurred. - */ - placeId?: string | null; - /** - * Name of the place where this activity occurred. - */ - placeName?: string | null; - /** - * The service provider that initially published this activity. - */ - provider?: {title?: string} | null; - /** - * The time at which this activity was initially published. Formatted as an RFC 3339 timestamp. - */ - published?: string | null; - /** - * Radius, in meters, of the region where this activity occurred, centered at the latitude and longitude identified in geocode. - */ - radius?: string | null; - /** - * Title of this activity. - */ - title?: string | null; - /** - * The time at which this activity was last updated. Formatted as an RFC 3339 timestamp. - */ - updated?: string | null; - /** - * The link to this activity. - */ - url?: string | null; - /** - * This activity's verb, which indicates the action that was performed. Possible values include, but are not limited to, the following values: - "post" - Publish content to the stream. - "share" - Reshare an activity. - */ - verb?: string | null; - } - export interface Schema$ActivityFeed { - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The ID of this collection of activities. Deprecated. - */ - id?: string | null; - /** - * The activities in this page of results. - */ - items?: Schema$Activity[]; - /** - * Identifies this resource as a collection of activities. Value: "plus#activityFeed". - */ - kind?: string | null; - /** - * Link to the next page of activities. - */ - nextLink?: string | null; - /** - * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. - */ - nextPageToken?: string | null; - /** - * Link to this activity resource. - */ - selfLink?: string | null; - /** - * The title of this collection of activities, which is a truncated portion of the content. - */ - title?: string | null; - /** - * The time at which this collection of activities was last updated. Formatted as an RFC 3339 timestamp. - */ - updated?: string | null; - } - export interface Schema$Audience { - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The access control list entry. - */ - item?: Schema$PlusDomainsAclentryResource; - /** - * Identifies this resource as an audience. Value: "plus#audience". - */ - kind?: string | null; - /** - * The number of people in this circle. This only applies if entity_type is CIRCLE. - */ - memberCount?: number | null; - /** - * The circle members' visibility as chosen by the owner of the circle. This only applies for items with "item.type" equals "circle". Possible values are: - "public" - Members are visible to the public. - "limited" - Members are visible to a limited audience. - "private" - Members are visible to the owner only. - */ - visibility?: string | null; - } - export interface Schema$AudiencesFeed { - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The audiences in this result. - */ - items?: Schema$Audience[]; - /** - * Identifies this resource as a collection of audiences. Value: "plus#audienceFeed". - */ - kind?: string | null; - /** - * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. - */ - nextPageToken?: string | null; - /** - * The total number of ACL entries. The number of entries in this response may be smaller due to paging. - */ - totalItems?: number | null; - } - export interface Schema$Circle { - /** - * The description of this circle. - */ - description?: string | null; - /** - * The circle name. - */ - displayName?: string | null; - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The ID of the circle. - */ - id?: string | null; - /** - * Identifies this resource as a circle. Value: "plus#circle". - */ - kind?: string | null; - /** - * The people in this circle. - */ - people?: {totalItems?: number} | null; - /** - * Link to this circle resource - */ - selfLink?: string | null; - } - export interface Schema$CircleFeed { - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The circles in this page of results. - */ - items?: Schema$Circle[]; - /** - * Identifies this resource as a collection of circles. Value: "plus#circleFeed". - */ - kind?: string | null; - /** - * Link to the next page of circles. - */ - nextLink?: string | null; - /** - * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. - */ - nextPageToken?: string | null; - /** - * Link to this page of circles. - */ - selfLink?: string | null; - /** - * The title of this list of resources. - */ - title?: string | null; - /** - * The total number of circles. The number of circles in this response may be smaller due to paging. - */ - totalItems?: number | null; - } - export interface Schema$Comment { - /** - * The person who posted this comment. - */ - actor?: { - clientSpecificActorInfo?: {youtubeActorInfo?: {channelId?: string}}; - displayName?: string; - id?: string; - image?: {url?: string}; - url?: string; - verification?: {adHocVerified?: string}; - } | null; - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The ID of this comment. - */ - id?: string | null; - /** - * The activity this comment replied to. - */ - inReplyTo?: Array<{id?: string; url?: string}> | null; - /** - * Identifies this resource as a comment. Value: "plus#comment". - */ - kind?: string | null; - /** - * The object of this comment. - */ - object?: { - content?: string; - objectType?: string; - originalContent?: string; - } | null; - /** - * People who +1'd this comment. - */ - plusoners?: {totalItems?: number} | null; - /** - * The time at which this comment was initially published. Formatted as an RFC 3339 timestamp. - */ - published?: string | null; - /** - * Link to this comment resource. - */ - selfLink?: string | null; - /** - * The time at which this comment was last updated. Formatted as an RFC 3339 timestamp. - */ - updated?: string | null; - /** - * This comment's verb, indicating what action was performed. Possible values are: - "post" - Publish content to the stream. - */ - verb?: string | null; - } - export interface Schema$CommentFeed { - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The ID of this collection of comments. - */ - id?: string | null; - /** - * The comments in this page of results. - */ - items?: Schema$Comment[]; - /** - * Identifies this resource as a collection of comments. Value: "plus#commentFeed". - */ - kind?: string | null; - /** - * Link to the next page of activities. - */ - nextLink?: string | null; - /** - * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. - */ - nextPageToken?: string | null; - /** - * The title of this collection of comments. - */ - title?: string | null; - /** - * The time at which this collection of comments was last updated. Formatted as an RFC 3339 timestamp. - */ - updated?: string | null; - } - export interface Schema$Media { - /** - * The person who uploaded this media. - */ - author?: { - displayName?: string; - id?: string; - image?: {url?: string}; - url?: string; - } | null; - /** - * The display name for this media. - */ - displayName?: string | null; - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * Exif information of the media item. - */ - exif?: {time?: string} | null; - /** - * The height in pixels of the original image. - */ - height?: number | null; - /** - * ID of this media, which is generated by the API. - */ - id?: string | null; - /** - * The type of resource. - */ - kind?: string | null; - /** - * The time at which this media was originally created in UTC. Formatted as an RFC 3339 timestamp that matches this example: 2010-11-25T14:30:27.655Z - */ - mediaCreatedTime?: string | null; - /** - * The URL of this photo or video's still image. - */ - mediaUrl?: string | null; - /** - * The time at which this media was uploaded. Formatted as an RFC 3339 timestamp. - */ - published?: string | null; - /** - * The size in bytes of this video. - */ - sizeBytes?: string | null; - /** - * The list of video streams for this video. There might be several different streams available for a single video, either Flash or MPEG, of various sizes - */ - streams?: Schema$Videostream[]; - /** - * A description, or caption, for this media. - */ - summary?: string | null; - /** - * The time at which this media was last updated. This includes changes to media metadata. Formatted as an RFC 3339 timestamp. - */ - updated?: string | null; - /** - * The URL for the page that hosts this media. - */ - url?: string | null; - /** - * The duration in milliseconds of this video. - */ - videoDuration?: string | null; - /** - * The encoding status of this video. Possible values are: - "UPLOADING" - Not all the video bytes have been received. - "PENDING" - Video not yet processed. - "FAILED" - Video processing failed. - "READY" - A single video stream is playable. - "FINAL" - All video streams are playable. - */ - videoStatus?: string | null; - /** - * The width in pixels of the original image. - */ - width?: number | null; - } - export interface Schema$PeopleFeed { - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The people in this page of results. Each item includes the id, displayName, image, and url for the person. To retrieve additional profile data, see the people.get method. - */ - items?: Schema$Person[]; - /** - * Identifies this resource as a collection of people. Value: "plus#peopleFeed". - */ - kind?: string | null; - /** - * The continuation token, which is used to page through large result sets. Provide this value in a subsequent request to return the next page of results. - */ - nextPageToken?: string | null; - /** - * Link to this resource. - */ - selfLink?: string | null; - /** - * The title of this collection of people. - */ - title?: string | null; - /** - * The total number of people available in this list. The number of people in a response might be smaller due to paging. This might not be set for all collections. - */ - totalItems?: number | null; - } - export interface Schema$Person { - /** - * A short biography for this person. - */ - aboutMe?: string | null; - /** - * The person's date of birth, represented as YYYY-MM-DD. - */ - birthday?: string | null; - /** - * The "bragging rights" line of this person. - */ - braggingRights?: string | null; - /** - * For followers who are visible, the number of people who have added this person or page to a circle. - */ - circledByCount?: number | null; - /** - * The cover photo content. - */ - cover?: { - coverInfo?: {leftImageOffset?: number; topImageOffset?: number}; - coverPhoto?: {height?: number; url?: string; width?: number}; - layout?: string; - } | null; - /** - * (this field is not currently used) - */ - currentLocation?: string | null; - /** - * The name of this person, which is suitable for display. - */ - displayName?: string | null; - /** - * The hosted domain name for the user's Google Apps account. For instance, example.com. The plus.profile.emails.read or email scope is needed to get this domain name. - */ - domain?: string | null; - /** - * A list of email addresses that this person has, including their Google account email address, and the public verified email addresses on their Google+ profile. The plus.profile.emails.read scope is needed to retrieve these email addresses, or the email scope can be used to retrieve just the Google account email address. - */ - emails?: Array<{type?: string; value?: string}> | null; - /** - * ETag of this response for caching purposes. - */ - etag?: string | null; - /** - * The person's gender. Possible values include, but are not limited to, the following values: - "male" - Male gender. - "female" - Female gender. - "other" - Other. - */ - gender?: string | null; - /** - * The ID of this person. - */ - id?: string | null; - /** - * The representation of the person's profile photo. - */ - image?: {isDefault?: boolean; url?: string} | null; - /** - * Whether this user has signed up for Google+. - */ - isPlusUser?: boolean | null; - /** - * Identifies this resource as a person. Value: "plus#person". - */ - kind?: string | null; - /** - * An object representation of the individual components of a person's name. - */ - name?: { - familyName?: string; - formatted?: string; - givenName?: string; - honorificPrefix?: string; - honorificSuffix?: string; - middleName?: string; - } | null; - /** - * The nickname of this person. - */ - nickname?: string | null; - /** - * Type of person within Google+. Possible values include, but are not limited to, the following values: - "person" - represents an actual person. - "page" - represents a page. - */ - objectType?: string | null; - /** - * The occupation of this person. - */ - occupation?: string | null; - /** - * A list of current or past organizations with which this person is associated. - */ - organizations?: Array<{ - department?: string; - description?: string; - endDate?: string; - location?: string; - name?: string; - primary?: boolean; - startDate?: string; - title?: string; - type?: string; - }> | null; - /** - * A list of places where this person has lived. - */ - placesLived?: Array<{primary?: boolean; value?: string}> | null; - /** - * If a Google+ Page, the number of people who have +1'd this page. - */ - plusOneCount?: number | null; - /** - * The person's relationship status. Possible values include, but are not limited to, the following values: - "single" - Person is single. - "in_a_relationship" - Person is in a relationship. - "engaged" - Person is engaged. - "married" - Person is married. - "its_complicated" - The relationship is complicated. - "open_relationship" - Person is in an open relationship. - "widowed" - Person is widowed. - "in_domestic_partnership" - Person is in a domestic partnership. - "in_civil_union" - Person is in a civil union. - */ - relationshipStatus?: string | null; - /** - * The person's skills. - */ - skills?: string | null; - /** - * The brief description (tagline) of this person. - */ - tagline?: string | null; - /** - * The URL of this person's profile. - */ - url?: string | null; - /** - * A list of URLs for this person. - */ - urls?: Array<{label?: string; type?: string; value?: string}> | null; - /** - * Whether the person or Google+ Page has been verified. - */ - verified?: boolean | null; - } - export interface Schema$Place { - /** - * The physical address of the place. - */ - address?: {formatted?: string} | null; - /** - * The display name of the place. - */ - displayName?: string | null; - /** - * The id of the place. - */ - id?: string | null; - /** - * Identifies this resource as a place. Value: "plus#place". - */ - kind?: string | null; - /** - * The position of the place. - */ - position?: {latitude?: number; longitude?: number} | null; - } - export interface Schema$PlusDomainsAclentryResource { - /** - * A descriptive name for this entry. Suitable for display. - */ - displayName?: string | null; - /** - * The ID of the entry. For entries of type "person" or "circle", this is the ID of the resource. For other types, this property is not set. - */ - id?: string | null; - /** - * The type of entry describing to whom access is granted. Possible values are: - "person" - Access to an individual. - "circle" - Access to members of a circle. - "myCircles" - Access to members of all the person's circles. - "extendedCircles" - Access to members of all the person's circles, plus all of the people in their circles. - "domain" - Access to members of the person's Google Apps domain. - "public" - Access to anyone on the web. - */ - type?: string | null; - } - export interface Schema$Videostream { - /** - * The height, in pixels, of the video resource. - */ - height?: number | null; - /** - * MIME type of the video stream. - */ - type?: string | null; - /** - * URL of the video stream. - */ - url?: string | null; - /** - * The width, in pixels, of the video resource. - */ - width?: number | null; - } - - export class Resource$Activities { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * plusDomains.activities.get - * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. - * @alias plusDomains.activities.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.activityId The ID of the activity 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$Activities$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Activities$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Activities$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Activities$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Activities$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Activities$Get; - 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/activities/{activityId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['activityId'], - pathParams: ['activityId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * plusDomains.activities.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. - * @alias plusDomains.activities.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.collection The collection of activities to list. - * @param {integer=} params.maxResults The maximum number of activities 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 {string} params.userId The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Activities$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Activities$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Activities$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Activities$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Activities$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Activities$List; - 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/people/{userId}/activities/{collection}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['userId', 'collection'], - pathParams: ['collection', 'userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Activities$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the activity to get. - */ - activityId?: string; - } - export interface Params$Resource$Activities$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The collection of activities to list. - */ - collection?: string; - /** - * The maximum number of activities 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; - /** - * The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. - */ - userId?: string; - } - - export class Resource$Audiences { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * plusDomains.audiences.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. - * @alias plusDomains.audiences.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults The maximum number of circles 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 {string} params.userId The ID of the user to get audiences for. The special value "me" can be used to indicate the authenticated user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Audiences$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Audiences$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Audiences$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Audiences$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Audiences$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Audiences$List; - 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/people/{userId}/audiences' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Audiences$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The maximum number of circles 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; - /** - * The ID of the user to get audiences for. The special value "me" can be used to indicate the authenticated user. - */ - userId?: string; - } - - export class Resource$Circles { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * plusDomains.circles.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. - * @alias plusDomains.circles.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults The maximum number of circles 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 {string} params.userId The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Circles$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Circles$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Circles$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Circles$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Circles$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Circles$List; - 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/people/{userId}/circles').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Circles$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The maximum number of circles 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; - /** - * The ID of the user to get circles for. The special value "me" can be used to indicate the authenticated user. - */ - userId?: string; - } - - export class Resource$Comments { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * plusDomains.comments.get - * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. - * @alias plusDomains.comments.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.commentId The ID of the comment 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$Comments$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Comments$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Comments$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Comments$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Comments$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Comments$Get; - 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/comments/{commentId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['commentId'], - pathParams: ['commentId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * plusDomains.comments.list - * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. - * @alias plusDomains.comments.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.activityId The ID of the activity to get comments for. - * @param {integer=} params.maxResults The maximum number of comments 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 {string=} params.sortOrder The order in which to sort the list of comments. - * @param {object} [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$Comments$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Comments$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Comments$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Comments$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Comments$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Comments$List; - 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/activities/{activityId}/comments' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['activityId'], - pathParams: ['activityId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Comments$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the comment to get. - */ - commentId?: string; - } - export interface Params$Resource$Comments$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the activity to get comments for. - */ - activityId?: string; - /** - * The maximum number of comments 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; - /** - * The order in which to sort the list of comments. - */ - sortOrder?: string; - } - - export class Resource$Media { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * plusDomains.media.insert - * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. - * @alias plusDomains.media.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.collection - * @param {string} params.userId The ID of the user to create the activity on behalf of. - * @param {object} params.requestBody 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 - */ - insert( - params?: Params$Resource$Media$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Media$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Media$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Media$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Media$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Media$Insert; - 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/people/{userId}/media/{collection}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - mediaUrl: ( - rootUrl + '/upload/plusDomains/v1/people/{userId}/media/{collection}' - ).replace(/([^:]\/)\/+/g, '$1'), - requiredParams: ['userId', 'collection'], - pathParams: ['collection', 'userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Media$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * - */ - collection?: string; - /** - * The ID of the user to create the activity on behalf of. - */ - userId?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Media; - - /** - * Media metadata - */ - media?: { - /** - * Media mime-type - */ - mimeType?: string; - - /** - * Media body contents - */ - body?: any; - }; - } - - export class Resource$People { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * plusDomains.people.get - * @desc Get a person's profile. - * @alias plusDomains.people.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.userId The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$People$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$People$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$People$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$People$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$People$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$People$Get; - 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/people/{userId}').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['userId'], - pathParams: ['userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * plusDomains.people.list - * @desc List all of the people in the specified collection. - * @alias plusDomains.people.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.collection The collection of people to list. - * @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.orderBy The order to return people in. - * @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 {string} params.userId Get the collection of people for the person identified. Use "me" to indicate the authenticated user. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$People$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$People$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$People$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$People$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$People$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$People$List; - 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/people/{userId}/people/{collection}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['userId', 'collection'], - pathParams: ['collection', 'userId'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * plusDomains.people.listByActivity - * @desc Shut down. See https://developers.google.com/+/api-shutdown for more details. - * @alias plusDomains.people.listByActivity - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.activityId The ID of the activity to get the list of people for. - * @param {string} params.collection The collection of people to list. - * @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 - */ - listByActivity( - params?: Params$Resource$People$Listbyactivity, - options?: MethodOptions - ): GaxiosPromise; - listByActivity( - params: Params$Resource$People$Listbyactivity, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - listByActivity( - params: Params$Resource$People$Listbyactivity, - callback: BodyResponseCallback - ): void; - listByActivity(callback: BodyResponseCallback): void; - listByActivity( - paramsOrCallback?: - | Params$Resource$People$Listbyactivity - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$People$Listbyactivity; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$People$Listbyactivity; - 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/activities/{activityId}/people/{collection}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['activityId', 'collection'], - pathParams: ['activityId', 'collection'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$People$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the person to get the profile for. The special value "me" can be used to indicate the authenticated user. - */ - userId?: string; - } - export interface Params$Resource$People$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The collection of people to list. - */ - collection?: 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 order to return people in. - */ - orderBy?: string; - /** - * 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; - /** - * Get the collection of people for the person identified. Use "me" to indicate the authenticated user. - */ - userId?: string; - } - export interface Params$Resource$People$Listbyactivity - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The ID of the activity to get the list of people for. - */ - activityId?: string; - /** - * The collection of people to list. - */ - collection?: 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/policytroubleshooter/v1.ts b/src/apis/policytroubleshooter/v1.ts index f48cbb9161..fe8d126d5c 100644 --- a/src/apis/policytroubleshooter/v1.ts +++ b/src/apis/policytroubleshooter/v1.ts @@ -292,23 +292,23 @@ export namespace policytroubleshooter_v1 { version?: number | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$GoogleTypeExpr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/policytroubleshooter/v1beta.ts b/src/apis/policytroubleshooter/v1beta.ts index f99d383c1c..91e7e83c48 100644 --- a/src/apis/policytroubleshooter/v1beta.ts +++ b/src/apis/policytroubleshooter/v1beta.ts @@ -292,23 +292,23 @@ export namespace policytroubleshooter_v1beta { version?: number | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$GoogleTypeExpr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/pubsub/v1.ts b/src/apis/pubsub/v1.ts index 5fa9896a10..bbee198dc7 100644 --- a/src/apis/pubsub/v1.ts +++ b/src/apis/pubsub/v1.ts @@ -120,7 +120,7 @@ export namespace pubsub_v1 { */ export interface Schema$AcknowledgeRequest { /** - * The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty. + * Required. The acknowledgment ID for the messages being acknowledged that was returned by the Pub/Sub system in the `Pull` response. Must not be empty. */ ackIds?: string[] | null; } @@ -150,10 +150,23 @@ export namespace pubsub_v1 { */ labels?: {[key: string]: string} | null; /** - * The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`. + * Required. The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the `CreateSnapshot` request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string | null; } + /** + * Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail. + */ + export interface Schema$DeadLetterPolicy { + /** + * The name of the topic to which dead letter messages should be published. Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service account associated with the enclosing subscription's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Publish() to this topic. The operation will fail if the topic does not exist. Users should ensure that there is a subscription attached to this topic since messages published to a topic with no subscriptions are lost. + */ + deadLetterTopic?: string | null; + /** + * The maximum number of delivery attempts for any message. The value must be between 5 and 100. The number of delivery attempts is defined as 1 + (the sum of number of NACKs and number of times the acknowledgement deadline has been exceeded for the message). A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that client libraries may automatically extend ack_deadlines. This field will be honored on a best effort basis. If this parameter is 0, a default value of 5 is used. + */ + maxDeliveryAttempts?: number | null; + } /** * 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 `{}`. */ @@ -168,23 +181,23 @@ export namespace pubsub_v1 { ttl?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -264,11 +277,11 @@ export namespace pubsub_v1 { */ export interface Schema$ModifyAckDeadlineRequest { /** - * The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes). + * Required. The new ack deadline with respect to the time this request was sent to the Pub/Sub system. For example, if the value is 10, the new ack deadline will expire 10 seconds after the `ModifyAckDeadline` call was made. Specifying zero might immediately make the message available for delivery to another subscriber client. This typically results in an increase in the rate of message redeliveries (that is, duplicates). The minimum deadline you can specify is 0 seconds. The maximum deadline you can specify is 600 seconds (10 minutes). */ ackDeadlineSeconds?: number | null; /** - * List of acknowledgment IDs. + * Required. List of acknowledgment IDs. */ ackIds?: string[] | null; } @@ -277,7 +290,7 @@ export namespace pubsub_v1 { */ export interface Schema$ModifyPushConfigRequest { /** - * The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called. + * Required. The push configuration for future deliveries. An empty `pushConfig` indicates that the Pub/Sub system should stop pushing messages from the given subscription and allow messages to be pulled and acknowledged - effectively pausing the subscription if `Pull` or `StreamingPull` is not called. */ pushConfig?: Schema$PushConfig; } @@ -316,7 +329,7 @@ export namespace pubsub_v1 { */ export interface Schema$PublishRequest { /** - * The messages to publish. + * Required. The messages to publish. */ messages?: Schema$PubsubMessage[]; } @@ -355,7 +368,7 @@ export namespace pubsub_v1 { */ export interface Schema$PullRequest { /** - * The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified. + * Required. The maximum number of messages to return for this request. Must be a positive integer. The Pub/Sub system may return fewer than the number specified. */ maxMessages?: number | null; /** @@ -397,6 +410,10 @@ export namespace pubsub_v1 { * This ID can be used to acknowledge the received message. */ ackId?: string | null; + /** + * Delivery attempt counter is 1 + (the sum of number of NACKs and number of ack_deadline exceeds) for this message. A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline exceeds event is whenever a message is not acknowledged within ack_deadline. Note that ack_deadline is initially Subscription.ackDeadlineSeconds, but may get extended automatically by the client library. The first delivery of a given message will have this value as 1. The value is calculated at best effort and is approximate. If a DeadLetterPolicy is not set on the subscription, this will be 0. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. + */ + deliveryAttempt?: number | null; /** * The message. */ @@ -457,6 +474,10 @@ export namespace pubsub_v1 { * The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be <i>outstanding</i>. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. */ ackDeadlineSeconds?: number | null; + /** + * A policy that specifies the conditions for dead lettering messages in this subscription. If dead_letter_policy is not set, dead lettering is disabled. The Cloud Pub/Sub service account associated with this subscriptions's parent project (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have permission to Acknowledge() messages on this subscription. <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy. + */ + deadLetterPolicy?: Schema$DeadLetterPolicy; /** * A policy that specifies the conditions for this subscription's expiration. A subscription is considered active as long as any connected subscriber is successfully consuming messages from the subscription or is issuing operations on the subscription. If `expiration_policy` is not set, a *default policy* with `ttl` of 31 days will be used. The minimum allowed value for `expiration_policy.ttl` is 1 day. */ @@ -470,7 +491,7 @@ export namespace pubsub_v1 { */ messageRetentionDuration?: string | null; /** - * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string | null; /** @@ -482,7 +503,7 @@ export namespace pubsub_v1 { */ retainAckedMessages?: boolean | null; /** - * The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. + * Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. */ topic?: string | null; } @@ -521,7 +542,7 @@ export namespace pubsub_v1 { */ messageStoragePolicy?: Schema$MessageStoragePolicy; /** - * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string | null; } @@ -530,11 +551,11 @@ export namespace pubsub_v1 { */ export interface Schema$UpdateSnapshotRequest { /** - * The updated snapshot object. + * Required. The updated snapshot object. */ snapshot?: Schema$Snapshot; /** - * Indicates which fields in the provided snapshot to update. Must be specified and non-empty. + * Required. Indicates which fields in the provided snapshot to update. Must be specified and non-empty. */ updateMask?: string | null; } @@ -543,11 +564,11 @@ export namespace pubsub_v1 { */ export interface Schema$UpdateSubscriptionRequest { /** - * The updated subscription object. + * Required. The updated subscription object. */ subscription?: Schema$Subscription; /** - * Indicates which fields in the provided subscription to update. Must be specified and non-empty. + * Required. Indicates which fields in the provided subscription to update. Must be specified and non-empty. */ updateMask?: string | null; } @@ -556,11 +577,11 @@ export namespace pubsub_v1 { */ export interface Schema$UpdateTopicRequest { /** - * The updated topic object. + * Required. The updated topic object. */ topic?: Schema$Topic; /** - * Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" then the new value will be determined based on the policy configured at the project or organization level. The `message_storage_policy` must not be set in the `topic` provided above. + * Required. Indicates which fields in the provided topic to update. Must be specified and non-empty. Note that if `update_mask` contains "message_storage_policy" then the new value will be determined based on the policy configured at the project or organization level. The `message_storage_policy` must not be set in the `topic` provided above. */ updateMask?: string | null; } @@ -648,7 +669,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. + * @param {string} params.name Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. * @param {().CreateSnapshotRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -762,7 +783,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.snapshot The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`. + * @param {string} params.snapshot Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -878,7 +899,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.snapshot The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`. + * @param {string} params.snapshot Required. The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -1129,7 +1150,7 @@ export namespace pubsub_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Maximum number of snapshots to return. * @param {string=} params.pageToken The value returned by the last `ListSnapshotsResponse`; indicates that this is a continuation of a prior `ListSnapshots` call, and that the system should return the next page of data. - * @param {string} params.project The name of the project in which to list snapshots. Format is `projects/{project-id}`. + * @param {string} params.project Required. The name of the project in which to list snapshots. Format is `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 @@ -1585,7 +1606,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. + * Required. User-provided name for this snapshot. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription. Note that for REST API requests, you must specify a name. See the resource name rules. Format is `projects/{project}/snapshots/{snap}`. */ name?: string; @@ -1602,7 +1623,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`. + * Required. The name of the snapshot to delete. Format is `projects/{project}/snapshots/{snap}`. */ snapshot?: string; } @@ -1614,7 +1635,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`. + * Required. The name of the snapshot to get. Format is `projects/{project}/snapshots/{snap}`. */ snapshot?: string; } @@ -1650,7 +1671,7 @@ export namespace pubsub_v1 { */ pageToken?: string; /** - * The name of the project in which to list snapshots. Format is `projects/{project-id}`. + * Required. The name of the project in which to list snapshots. Format is `projects/{project-id}`. */ project?: string; } @@ -1767,7 +1788,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.subscription The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`. + * @param {string} params.subscription Required. The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`. * @param {().AcknowledgeRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -1896,7 +1917,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * @param {string} params.name Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. * @param {().Subscription} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2012,7 +2033,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.subscription The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`. + * @param {string} params.subscription Required. The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2131,7 +2152,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.subscription The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`. + * @param {string} params.subscription Required. The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -2387,7 +2408,7 @@ export namespace pubsub_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Maximum number of subscriptions to return. * @param {string=} params.pageToken The value returned by the last `ListSubscriptionsResponse`; indicates that this is a continuation of a prior `ListSubscriptions` call, and that the system should return the next page of data. - * @param {string} params.project The name of the project in which to list subscriptions. Format is `projects/{project-id}`. + * @param {string} params.project Required. The name of the project in which to list subscriptions. Format is `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 @@ -2516,7 +2537,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.subscription The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. + * @param {string} params.subscription Required. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. * @param {().ModifyAckDeadlineRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2637,7 +2658,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.subscription The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. + * @param {string} params.subscription Required. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. * @param {().ModifyPushConfigRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2766,7 +2787,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * @param {string} params.name Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. * @param {().UpdateSubscriptionRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -2889,7 +2910,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.subscription The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`. + * @param {string} params.subscription Required. The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`. * @param {().PullRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3014,7 +3035,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.subscription The subscription to affect. + * @param {string} params.subscription Required. The subscription to affect. * @param {().SeekRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3348,7 +3369,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`. + * Required. The subscription whose message is being acknowledged. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; @@ -3365,7 +3386,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -3382,7 +3403,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`. + * Required. The subscription to delete. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; } @@ -3394,7 +3415,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`. + * Required. The name of the subscription to get. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; } @@ -3430,7 +3451,7 @@ export namespace pubsub_v1 { */ pageToken?: string; /** - * The name of the project in which to list subscriptions. Format is `projects/{project-id}`. + * Required. The name of the project in which to list subscriptions. Format is `projects/{project-id}`. */ project?: string; } @@ -3442,7 +3463,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. + * Required. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; @@ -3459,7 +3480,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. + * Required. The name of the subscription. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; @@ -3476,7 +3497,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -3493,7 +3514,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`. + * Required. The subscription from which messages should be pulled. Format is `projects/{project}/subscriptions/{sub}`. */ subscription?: string; @@ -3510,7 +3531,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The subscription to affect. + * Required. The subscription to affect. */ subscription?: string; @@ -3629,7 +3650,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * @param {string} params.name Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. * @param {().Topic} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -3743,7 +3764,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.topic Name of the topic to delete. Format is `projects/{project}/topics/{topic}`. + * @param {string} params.topic Required. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -3859,7 +3880,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.topic The name of the topic to get. Format is `projects/{project}/topics/{topic}`. + * @param {string} params.topic Required. The name of the topic to get. Format is `projects/{project}/topics/{topic}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -4110,7 +4131,7 @@ export namespace pubsub_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Maximum number of topics to return. * @param {string=} params.pageToken The value returned by the last `ListTopicsResponse`; indicates that this is a continuation of a prior `ListTopics` call, and that the system should return the next page of data. - * @param {string} params.project The name of the project in which to list topics. Format is `projects/{project-id}`. + * @param {string} params.project Required. The name of the project in which to list topics. Format is `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 @@ -4240,7 +4261,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * @param {string} params.name Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. * @param {().UpdateTopicRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4361,7 +4382,7 @@ export namespace pubsub_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.topic The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`. + * @param {string} params.topic Required. The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`. * @param {().PublishRequest} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4695,7 +4716,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -4712,7 +4733,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Name of the topic to delete. Format is `projects/{project}/topics/{topic}`. + * Required. Name of the topic to delete. Format is `projects/{project}/topics/{topic}`. */ topic?: string; } @@ -4724,7 +4745,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the topic to get. Format is `projects/{project}/topics/{topic}`. + * Required. The name of the topic to get. Format is `projects/{project}/topics/{topic}`. */ topic?: string; } @@ -4760,7 +4781,7 @@ export namespace pubsub_v1 { */ pageToken?: string; /** - * The name of the project in which to list topics. Format is `projects/{project-id}`. + * Required. The name of the project in which to list topics. Format is `projects/{project-id}`. */ project?: string; } @@ -4772,7 +4793,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. + * Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. */ name?: string; @@ -4789,7 +4810,7 @@ export namespace pubsub_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`. + * Required. The messages in the request will be published on this topic. Format is `projects/{project}/topics/{topic}`. */ topic?: string; @@ -5079,7 +5100,7 @@ export namespace pubsub_v1 { * @param {object} params Parameters for request * @param {integer=} params.pageSize Maximum number of subscription names to return. * @param {string=} params.pageToken The value returned by the last `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a prior `ListTopicSubscriptions` call, and that the system should return the next page of data. - * @param {string} params.topic The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`. + * @param {string} params.topic Required. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object @@ -5172,7 +5193,7 @@ export namespace pubsub_v1 { */ pageToken?: string; /** - * The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`. + * Required. The name of the topic that subscriptions are attached to. Format is `projects/{project}/topics/{topic}`. */ topic?: string; } diff --git a/src/apis/pubsub/v1beta2.ts b/src/apis/pubsub/v1beta2.ts index abffd0e507..d1e48c8021 100644 --- a/src/apis/pubsub/v1beta2.ts +++ b/src/apis/pubsub/v1beta2.ts @@ -146,23 +146,23 @@ export namespace pubsub_v1beta2 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/recommender/v1beta1.ts b/src/apis/recommender/v1beta1.ts index 257439a6fd..dd20cfe67e 100644 --- a/src/apis/recommender/v1beta1.ts +++ b/src/apis/recommender/v1beta1.ts @@ -172,7 +172,7 @@ export namespace recommender_v1beta1 { */ export interface Schema$GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest { /** - * Required. Fingerprint of the Recommendation. Provides optimistic locking. + * Fingerprint of the Recommendation. Provides optimistic locking. */ etag?: string | null; /** diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index c6f42bfd75..d012851bc4 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -233,6 +233,10 @@ export namespace redis_v1 { * Optional. The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. */ authorizedNetwork?: string | null; + /** + * Optional. The connect mode of Redis instance. If not provided, default one will be used. Current default: DIRECT_PEERING. + */ + connectMode?: string | null; /** * Output only. The time the instance was created. */ diff --git a/src/apis/redis/v1beta1.ts b/src/apis/redis/v1beta1.ts index 2e83dc5b68..1e55d3cefb 100644 --- a/src/apis/redis/v1beta1.ts +++ b/src/apis/redis/v1beta1.ts @@ -233,6 +233,10 @@ export namespace redis_v1beta1 { * Optional. The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. */ authorizedNetwork?: string | null; + /** + * Optional. The connect mode of Redis instance. If not provided, default one will be used. Current default: DIRECT_PEERING. + */ + connectMode?: string | null; /** * Output only. The time the instance was created. */ @@ -417,6 +421,15 @@ export namespace redis_v1beta1 { */ message?: string | null; } + /** + * Request for UpgradeInstance. + */ + export interface Schema$UpgradeInstanceRequest { + /** + * Required. Specifies the target version of Redis software to upgrade to. + */ + redisVersion?: string | null; + } export class Resource$Projects { context: APIRequestContext; @@ -1222,6 +1235,81 @@ export namespace redis_v1beta1 { return createAPIRequest(parameters); } } + + /** + * redis.projects.locations.instances.upgrade + * @desc Upgrades Redis instance to the newer Redis version specified in the request. + * @alias redis.projects.locations.instances.upgrade + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + * @param {().UpgradeInstanceRequest} params.requestBody Request 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 + */ + upgrade( + params?: Params$Resource$Projects$Locations$Instances$Upgrade, + options?: MethodOptions + ): GaxiosPromise; + upgrade( + params: Params$Resource$Projects$Locations$Instances$Upgrade, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upgrade( + params: Params$Resource$Projects$Locations$Instances$Upgrade, + callback: BodyResponseCallback + ): void; + upgrade(callback: BodyResponseCallback): void; + upgrade( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Upgrade + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Upgrade; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Upgrade; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:upgrade').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$Instances$Create @@ -1361,6 +1449,23 @@ export namespace redis_v1beta1 { */ requestBody?: Schema$Instance; } + export interface Params$Resource$Projects$Locations$Instances$Upgrade + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UpgradeInstanceRequest; + } export class Resource$Projects$Locations$Operations { context: APIRequestContext; diff --git a/src/apis/remotebuildexecution/v1.ts b/src/apis/remotebuildexecution/v1.ts index 84bb278d20..bde816fd8f 100644 --- a/src/apis/remotebuildexecution/v1.ts +++ b/src/apis/remotebuildexecution/v1.ts @@ -812,6 +812,10 @@ export namespace remotebuildexecution_v1 { * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ machineType?: string | null; + /** + * The maximum number of actions a worker can execute concurrently. + */ + maxConcurrentActions?: string | null; /** * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ diff --git a/src/apis/remotebuildexecution/v1alpha.ts b/src/apis/remotebuildexecution/v1alpha.ts index 2055c97119..6dd91f8917 100644 --- a/src/apis/remotebuildexecution/v1alpha.ts +++ b/src/apis/remotebuildexecution/v1alpha.ts @@ -799,6 +799,10 @@ export namespace remotebuildexecution_v1alpha { * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ machineType?: string | null; + /** + * The maximum number of actions a worker can execute concurrently. + */ + maxConcurrentActions?: string | null; /** * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ diff --git a/src/apis/remotebuildexecution/v2.ts b/src/apis/remotebuildexecution/v2.ts index 12c1ea826e..456ce1aa76 100644 --- a/src/apis/remotebuildexecution/v2.ts +++ b/src/apis/remotebuildexecution/v2.ts @@ -1067,6 +1067,10 @@ export namespace remotebuildexecution_v2 { * Required. Machine type of the worker, such as `n1-standard-2`. See https://cloud.google.com/compute/docs/machine-types for a list of supported machine types. Note that `f1-micro` and `g1-small` are not yet supported. */ machineType?: string | null; + /** + * The maximum number of actions a worker can execute concurrently. + */ + maxConcurrentActions?: string | null; /** * Minimum CPU platform to use when creating the worker. See [CPU Platforms](https://cloud.google.com/compute/docs/cpu-platforms). */ diff --git a/src/apis/replicapool/v1beta1.ts b/src/apis/replicapool/v1beta1.ts deleted file mode 100644 index 3492e35b81..0000000000 --- a/src/apis/replicapool/v1beta1.ts +++ /dev/null @@ -1,1528 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace replicapool_v1beta1 { - export interface Options extends GlobalOptions { - version: 'v1beta1'; - } - - interface StandardParameters { - /** - * Data format for the response. - */ - alt?: string; - /** - * Selector specifying which fields to include in a partial response. - */ - fields?: string; - /** - * API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. - */ - key?: string; - /** - * OAuth 2.0 token for the current user. - */ - oauth_token?: string; - /** - * Returns response with indentations and line breaks. - */ - prettyPrint?: boolean; - /** - * An opaque string that represents a user for quota purposes. Must not exceed 40 characters. - */ - quotaUser?: string; - /** - * Deprecated. Please use quotaUser instead. - */ - userIp?: string; - } - - /** - * Replica Pool API - * - * The Replica Pool API allows users to declaratively provision and manage groups of Google Compute Engine instances based on a common template. - * - * @example - * const {google} = require('googleapis'); - * const replicapool = google.replicapool('v1beta1'); - * - * @namespace replicapool - * @type {Function} - * @version v1beta1 - * @variation v1beta1 - * @param {object=} options Options for Replicapool - */ - export class Replicapool { - context: APIRequestContext; - pools: Resource$Pools; - replicas: Resource$Replicas; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.pools = new Resource$Pools(this.context); - this.replicas = new Resource$Replicas(this.context); - } - } - - /** - * A Compute Engine network accessConfig. Identical to the accessConfig on corresponding Compute Engine resource. - */ - export interface Schema$AccessConfig { - /** - * Name of this access configuration. - */ - name?: string | null; - /** - * An external IP address associated with this instance. - */ - natIp?: string | null; - /** - * Type of this access configuration file. Currently only ONE_TO_ONE_NAT is supported. - */ - type?: string | null; - } - /** - * An action that gets executed during initialization of the replicas. - */ - export interface Schema$Action { - /** - * A list of commands to run, one per line. If any command fails, the whole action is considered a failure and no further actions are run. This also marks the virtual machine or replica as a failure. - */ - commands?: string[] | null; - /** - * A list of environment variables to use for the commands in this action. - */ - envVariables?: Schema$EnvVariable[]; - /** - * If an action's commands on a particular replica do not finish in the specified timeoutMilliSeconds, the replica is considered to be in a FAILING state. No efforts are made to stop any processes that were spawned or created as the result of running the action's commands. The default is the max allowed value, 1 hour (i.e. 3600000 milliseconds). - */ - timeoutMilliSeconds?: number | null; - } - /** - * Specifies how to attach a disk to a Replica. - */ - export interface Schema$DiskAttachment { - /** - * The device name of this disk. - */ - deviceName?: string | null; - /** - * A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, this is assigned by the server. - */ - index?: number | null; - } - /** - * An environment variable to set for an action. - */ - export interface Schema$EnvVariable { - /** - * Deprecated, do not use. - */ - hidden?: boolean | null; - /** - * The name of the environment variable. - */ - name?: string | null; - /** - * The value of the variable. - */ - value?: string | null; - } - /** - * A pre-existing persistent disk that will be attached to every Replica in the Pool in READ_ONLY mode. - */ - export interface Schema$ExistingDisk { - /** - * How the disk will be attached to the Replica. - */ - attachment?: Schema$DiskAttachment; - /** - * The name of the Persistent Disk resource. The Persistent Disk resource must be in the same zone as the Pool. - */ - source?: string | null; - } - export interface Schema$HealthCheck { - /** - * How often (in seconds) to make HTTP requests for this healthcheck. The default value is 5 seconds. - */ - checkIntervalSec?: number | null; - /** - * The description for this health check. - */ - description?: string | null; - /** - * The number of consecutive health check requests that need to succeed before the replica is considered healthy again. The default value is 2. - */ - healthyThreshold?: number | null; - /** - * The value of the host header in the HTTP health check request. If left empty (default value), the localhost IP 127.0.0.1 will be used. - */ - host?: string | null; - /** - * The name of this health check. - */ - name?: string | null; - /** - * The localhost request path to send this health check, in the format /path/to/use. For example, /healthcheck. - */ - path?: string | null; - /** - * The TCP port for the health check requests. - */ - port?: number | null; - /** - * How long (in seconds) to wait before a timeout failure for this healthcheck. The default value is 5 seconds. - */ - timeoutSec?: number | null; - /** - * The number of consecutive health check requests that need to fail in order to consider the replica unhealthy. The default value is 2. - */ - unhealthyThreshold?: number | null; - } - /** - * A label to apply to this replica pool. - */ - export interface Schema$Label { - /** - * The key for this label. - */ - key?: string | null; - /** - * The value of this label. - */ - value?: string | null; - } - /** - * A Compute Engine metadata entry. Identical to the metadata on the corresponding Compute Engine resource. - */ - export interface Schema$Metadata { - /** - * The fingerprint of the metadata. Required for updating the metadata entries for this instance. - */ - fingerPrint?: string | null; - /** - * A list of metadata items. - */ - items?: Schema$MetadataItem[]; - } - /** - * A Compute Engine metadata item, defined as a key:value pair. Identical to the metadata on the corresponding Compute Engine resource. - */ - export interface Schema$MetadataItem { - /** - * A metadata key. - */ - key?: string | null; - /** - * A metadata value. - */ - value?: string | null; - } - /** - * A Compute Engine NetworkInterface resource. Identical to the NetworkInterface on the corresponding Compute Engine resource. - */ - export interface Schema$NetworkInterface { - /** - * An array of configurations for this interface. This specifies how this interface is configured to interact with other network services. - */ - accessConfigs?: Schema$AccessConfig[]; - /** - * Name the Network resource to which this interface applies. - */ - network?: string | null; - /** - * An optional IPV4 internal network address to assign to the instance for this network interface. - */ - networkIp?: string | null; - } - /** - * A Persistent Disk resource that will be created and attached to each Replica in the Pool. Each Replica will have a unique persistent disk that is created and attached to that Replica in READ_WRITE mode. - */ - export interface Schema$NewDisk { - /** - * How the disk will be attached to the Replica. - */ - attachment?: Schema$DiskAttachment; - /** - * If true, then this disk will be deleted when the instance is deleted. The default value is true. - */ - autoDelete?: boolean | null; - /** - * If true, indicates that this is the root persistent disk. - */ - boot?: boolean | null; - /** - * Create the new disk using these parameters. The name of the disk will be <instance_name>-<four_random_charactersgt;. - */ - initializeParams?: Schema$NewDiskInitializeParams; - } - /** - * Initialization parameters for creating a new disk. - */ - export interface Schema$NewDiskInitializeParams { - /** - * The size of the created disk in gigabytes. - */ - diskSizeGb?: string | null; - /** - * Name of the disk type resource describing which disk type to use to create the disk. For example 'pd-ssd' or 'pd-standard'. Default is 'pd-standard' - */ - diskType?: string | null; - /** - * The name or fully-qualified URL of a source image to use to create this disk. If you provide a name of the source image, Replica Pool will look for an image with that name in your project. If you are specifying an image provided by Compute Engine, you will need to provide the full URL with the correct project, such as: http://www.googleapis.com/compute/v1/projects/debian-cloud/ global/images/debian-wheezy-7-vYYYYMMDD - */ - sourceImage?: string | null; - } - export interface Schema$Pool { - /** - * Whether replicas in this pool should be restarted if they experience a failure. The default value is true. - */ - autoRestart?: boolean | null; - /** - * The base instance name to use for the replicas in this pool. This must match the regex [a-z]([-a-z0-9]*[a-z0-9])?. If specified, the instances in this replica pool will be named in the format <base-instance-name>-<ID>. The <ID> postfix will be a four character alphanumeric identifier generated by the service. If this is not specified by the user, a random base instance name is generated by the service. - */ - baseInstanceName?: string | null; - /** - * [Output Only] The current number of replicas in the pool. - */ - currentNumReplicas?: number | null; - /** - * An optional description of the replica pool. - */ - description?: string | null; - /** - * Deprecated. Please use template[].healthChecks instead. - */ - healthChecks?: Schema$HealthCheck[]; - /** - * The initial number of replicas this pool should have. You must provide a value greater than or equal to 0. - */ - initialNumReplicas?: number | null; - /** - * A list of labels to attach to this replica pool and all created virtual machines in this replica pool. - */ - labels?: Schema$Label[]; - /** - * The name of the replica pool. Must follow the regex [a-z]([-a-z0-9]*[a-z0-9])? and be 1-28 characters long. - */ - name?: string | null; - /** - * Deprecated! Use initial_num_replicas instead. - */ - numReplicas?: number | null; - /** - * The list of resource views that should be updated with all the replicas that are managed by this pool. - */ - resourceViews?: string[] | null; - /** - * [Output Only] A self-link to the replica pool. - */ - selfLink?: string | null; - /** - * Deprecated, please use target_pools instead. - */ - targetPool?: string | null; - /** - * A list of target pools to update with the replicas that are managed by this pool. If specified, the replicas in this replica pool will be added to the specified target pools for load balancing purposes. The replica pool must live in the same region as the specified target pools. These values must be the target pool resource names, and not fully qualified URLs. - */ - targetPools?: string[] | null; - /** - * The template to use when creating replicas in this pool. This template is used during initial instance creation of the pool, when growing the pool in size, or when a replica restarts. - */ - template?: Schema$Template; - /** - * Deprecated! Do not set. - */ - type?: string | null; - } - export interface Schema$PoolsDeleteRequest { - /** - * If there are instances you would like to keep, you can specify them here. These instances won't be deleted, but the associated replica objects will be removed. - */ - abandonInstances?: string[] | null; - } - export interface Schema$PoolsListResponse { - nextPageToken?: string | null; - resources?: Schema$Pool[]; - } - /** - * An individual Replica within a Pool. Replicas are automatically created by the replica pool, using the template provided by the user. You cannot directly create replicas. - */ - export interface Schema$Replica { - /** - * [Output Only] The name of the Replica object. - */ - name?: string | null; - /** - * [Output Only] The self-link of the Replica. - */ - selfLink?: string | null; - /** - * [Output Only] Last known status of the Replica. - */ - status?: Schema$ReplicaStatus; - } - export interface Schema$ReplicasDeleteRequest { - /** - * Whether the instance resource represented by this replica should be deleted or abandoned. If abandoned, the replica will be deleted but the virtual machine instance will remain. By default, this is set to false and the instance will be deleted along with the replica. - */ - abandonInstance?: boolean | null; - } - export interface Schema$ReplicasListResponse { - nextPageToken?: string | null; - resources?: Schema$Replica[]; - } - /** - * The current status of a Replica. - */ - export interface Schema$ReplicaStatus { - /** - * [Output Only] Human-readable details about the current state of the replica - */ - details?: string | null; - /** - * [Output Only] The state of the Replica. - */ - state?: string | null; - /** - * [Output Only] The template used to build the replica. - */ - templateVersion?: string | null; - /** - * [Output Only] Link to the virtual machine that this Replica represents. - */ - vmLink?: string | null; - /** - * [Output Only] The time that this Replica got to the RUNNING state, in RFC 3339 format. If the start time is unknown, UNKNOWN is returned. - */ - vmStartTime?: string | null; - } - /** - * A Compute Engine service account, identical to the Compute Engine resource. - */ - export interface Schema$ServiceAccount { - /** - * The service account email address, for example: 123845678986@project.gserviceaccount.com - */ - email?: string | null; - /** - * The list of OAuth2 scopes to obtain for the service account, for example: https://www.googleapis.com/auth/devstorage.full_control - */ - scopes?: string[] | null; - } - /** - * A Compute Engine Instance tag, identical to the tags on the corresponding Compute Engine Instance resource. - */ - export interface Schema$Tag { - /** - * The fingerprint of the tag. Required for updating the list of tags. - */ - fingerPrint?: string | null; - /** - * Items contained in this tag. - */ - items?: string[] | null; - } - /** - * The template used for creating replicas in the pool. - */ - export interface Schema$Template { - /** - * An action to run during initialization of your replicas. An action is run as shell commands which are executed one after the other in the same bash shell, so any state established by one command is inherited by later commands. - */ - action?: Schema$Action; - /** - * A list of HTTP Health Checks to configure for this replica pool and all virtual machines in this replica pool. - */ - healthChecks?: Schema$HealthCheck[]; - /** - * A free-form string describing the version of this template. You can provide any versioning string you would like. For example, version1 or template-v1. - */ - version?: string | null; - /** - * The virtual machine parameters to use for creating replicas. You can define settings such as the machine type and the image of replicas in this pool. This is required if replica type is SMART_VM. - */ - vmParams?: Schema$VmParams; - } - /** - * Parameters for creating a Compute Engine Instance resource. Most fields are identical to the corresponding Compute Engine resource. - */ - export interface Schema$VmParams { - /** - * Deprecated. Please use baseInstanceName instead. - */ - baseInstanceName?: string | null; - /** - * Enables IP Forwarding, which allows this instance to receive packets destined for a different IP address, and send packets with a different source IP. See IP Forwarding for more information. - */ - canIpForward?: boolean | null; - /** - * An optional textual description of the instance. - */ - description?: string | null; - /** - * A list of existing Persistent Disk resources to attach to each replica in the pool. Each disk will be attached in read-only mode to every replica. - */ - disksToAttach?: Schema$ExistingDisk[]; - /** - * A list of Disk resources to create and attach to each Replica in the Pool. Currently, you can only define one disk and it must be a root persistent disk. Note that Replica Pool will create a root persistent disk for each replica. - */ - disksToCreate?: Schema$NewDisk[]; - /** - * The machine type for this instance. The resource name (e.g. n1-standard-1). - */ - machineType?: string | null; - /** - * The metadata key/value pairs assigned to this instance. - */ - metadata?: Schema$Metadata; - /** - * A list of network interfaces for the instance. Currently only one interface is supported by Google Compute Engine, ONE_TO_ONE_NAT. - */ - networkInterfaces?: Schema$NetworkInterface[]; - onHostMaintenance?: string | null; - /** - * A list of Service Accounts to enable for this instance. - */ - serviceAccounts?: Schema$ServiceAccount[]; - /** - * A list of tags to apply to the Google Compute Engine instance to identify resources. - */ - tags?: Schema$Tag; - } - - export class Resource$Pools { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * replicapool.pools.delete - * @desc Deletes a replica pool. - * @alias replicapool.pools.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.poolName The name of the replica pool for this request. - * @param {string} params.projectName The project ID for this replica pool. - * @param {string} params.zone The zone for this replica pool. - * @param {().PoolsDeleteRequest} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Pools$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Pools$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Pools$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Pools$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Pools$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pools$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools/{poolName}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['projectName', 'zone', 'poolName'], - pathParams: ['poolName', 'projectName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * replicapool.pools.get - * @desc Gets information about a single replica pool. - * @alias replicapool.pools.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.poolName The name of the replica pool for this request. - * @param {string} params.projectName The project ID for this replica pool. - * @param {string} params.zone The zone for this replica pool. - * @param {object} [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$Pools$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Pools$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Pools$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Pools$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Pools$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pools$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools/{poolName}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['projectName', 'zone', 'poolName'], - pathParams: ['poolName', 'projectName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * replicapool.pools.insert - * @desc Inserts a new replica pool. - * @alias replicapool.pools.insert - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.projectName The project ID for this replica pool. - * @param {string} params.zone The zone for this replica pool. - * @param {().Pool} params.requestBody Request 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$Pools$Insert, - options?: MethodOptions - ): GaxiosPromise; - insert( - params: Params$Resource$Pools$Insert, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - insert( - params: Params$Resource$Pools$Insert, - callback: BodyResponseCallback - ): void; - insert(callback: BodyResponseCallback): void; - insert( - paramsOrCallback?: - | Params$Resource$Pools$Insert - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Pools$Insert; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pools$Insert; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['projectName', 'zone'], - pathParams: ['projectName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * replicapool.pools.list - * @desc List all replica pools. - * @alias replicapool.pools.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50) - * @param {string=} params.pageToken Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request. - * @param {string} params.projectName The project ID for this request. - * @param {string} params.zone The zone for this replica pool. - * @param {object} [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$Pools$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Pools$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Pools$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Pools$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Pools$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pools$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['projectName', 'zone'], - pathParams: ['projectName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * replicapool.pools.resize - * @desc Resize a pool. This is an asynchronous operation, and multiple overlapping resize requests can be made. Replica Pools will use the information from the last resize request. - * @alias replicapool.pools.resize - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.numReplicas The desired number of replicas to resize to. If this number is larger than the existing number of replicas, new replicas will be added. If the number is smaller, then existing replicas will be deleted. - * @param {string} params.poolName The name of the replica pool for this request. - * @param {string} params.projectName The project ID for this replica pool. - * @param {string} params.zone The zone for this replica pool. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - resize( - params?: Params$Resource$Pools$Resize, - options?: MethodOptions - ): GaxiosPromise; - resize( - params: Params$Resource$Pools$Resize, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - resize( - params: Params$Resource$Pools$Resize, - callback: BodyResponseCallback - ): void; - resize(callback: BodyResponseCallback): void; - resize( - paramsOrCallback?: - | Params$Resource$Pools$Resize - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Pools$Resize; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pools$Resize; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools/{poolName}/resize' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['projectName', 'zone', 'poolName'], - pathParams: ['poolName', 'projectName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * replicapool.pools.updatetemplate - * @desc Update the template used by the pool. - * @alias replicapool.pools.updatetemplate - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.poolName The name of the replica pool for this request. - * @param {string} params.projectName The project ID for this replica pool. - * @param {string} params.zone The zone for this replica pool. - * @param {().Template} params.requestBody Request 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 - */ - updatetemplate( - params?: Params$Resource$Pools$Updatetemplate, - options?: MethodOptions - ): GaxiosPromise; - updatetemplate( - params: Params$Resource$Pools$Updatetemplate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - updatetemplate( - params: Params$Resource$Pools$Updatetemplate, - callback: BodyResponseCallback - ): void; - updatetemplate(callback: BodyResponseCallback): void; - updatetemplate( - paramsOrCallback?: - | Params$Resource$Pools$Updatetemplate - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Pools$Updatetemplate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Pools$Updatetemplate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools/{poolName}/updateTemplate' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['projectName', 'zone', 'poolName'], - pathParams: ['poolName', 'projectName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Pools$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the replica pool for this request. - */ - poolName?: string; - /** - * The project ID for this replica pool. - */ - projectName?: string; - /** - * The zone for this replica pool. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$PoolsDeleteRequest; - } - export interface Params$Resource$Pools$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the replica pool for this request. - */ - poolName?: string; - /** - * The project ID for this replica pool. - */ - projectName?: string; - /** - * The zone for this replica pool. - */ - zone?: string; - } - export interface Params$Resource$Pools$Insert extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The project ID for this replica pool. - */ - projectName?: string; - /** - * The zone for this replica pool. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Pool; - } - export interface Params$Resource$Pools$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50) - */ - maxResults?: number; - /** - * Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request. - */ - pageToken?: string; - /** - * The project ID for this request. - */ - projectName?: string; - /** - * The zone for this replica pool. - */ - zone?: string; - } - export interface Params$Resource$Pools$Resize extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The desired number of replicas to resize to. If this number is larger than the existing number of replicas, new replicas will be added. If the number is smaller, then existing replicas will be deleted. - */ - numReplicas?: number; - /** - * The name of the replica pool for this request. - */ - poolName?: string; - /** - * The project ID for this replica pool. - */ - projectName?: string; - /** - * The zone for this replica pool. - */ - zone?: string; - } - export interface Params$Resource$Pools$Updatetemplate - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the replica pool for this request. - */ - poolName?: string; - /** - * The project ID for this replica pool. - */ - projectName?: string; - /** - * The zone for this replica pool. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Template; - } - - export class Resource$Replicas { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * replicapool.replicas.delete - * @desc Deletes a replica from the pool. - * @alias replicapool.replicas.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.poolName The replica pool name for this request. - * @param {string} params.projectName The project ID for this request. - * @param {string} params.replicaName The name of the replica for this request. - * @param {string} params.zone The zone where the replica lives. - * @param {().ReplicasDeleteRequest} params.requestBody Request body data - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Replicas$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Replicas$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Replicas$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Replicas$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Replicas$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Replicas$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools/{poolName}/replicas/{replicaName}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['projectName', 'zone', 'poolName', 'replicaName'], - pathParams: ['poolName', 'projectName', 'replicaName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * replicapool.replicas.get - * @desc Gets information about a specific replica. - * @alias replicapool.replicas.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.poolName The replica pool name for this request. - * @param {string} params.projectName The project ID for this request. - * @param {string} params.replicaName The name of the replica for this request. - * @param {string} params.zone The zone where the replica lives. - * @param {object} [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$Replicas$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Replicas$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Replicas$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Replicas$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Replicas$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Replicas$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools/{poolName}/replicas/{replicaName}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['projectName', 'zone', 'poolName', 'replicaName'], - pathParams: ['poolName', 'projectName', 'replicaName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * replicapool.replicas.list - * @desc Lists all replicas in a pool. - * @alias replicapool.replicas.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.maxResults Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50) - * @param {string=} params.pageToken Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request. - * @param {string} params.poolName The replica pool name for this request. - * @param {string} params.projectName The project ID for this request. - * @param {string} params.zone The zone where the replica pool lives. - * @param {object} [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$Replicas$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Replicas$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Replicas$List, - callback: BodyResponseCallback - ): void; - list(callback: BodyResponseCallback): void; - list( - paramsOrCallback?: - | Params$Resource$Replicas$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Replicas$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Replicas$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools/{poolName}/replicas' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['projectName', 'zone', 'poolName'], - pathParams: ['poolName', 'projectName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * replicapool.replicas.restart - * @desc Restarts a replica in a pool. - * @alias replicapool.replicas.restart - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.poolName The replica pool name for this request. - * @param {string} params.projectName The project ID for this request. - * @param {string} params.replicaName The name of the replica for this request. - * @param {string} params.zone The zone where the replica lives. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - restart( - params?: Params$Resource$Replicas$Restart, - options?: MethodOptions - ): GaxiosPromise; - restart( - params: Params$Resource$Replicas$Restart, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - restart( - params: Params$Resource$Replicas$Restart, - callback: BodyResponseCallback - ): void; - restart(callback: BodyResponseCallback): void; - restart( - paramsOrCallback?: - | Params$Resource$Replicas$Restart - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$Replicas$Restart; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Replicas$Restart; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/replicapool/v1beta1/projects/{projectName}/zones/{zone}/pools/{poolName}/replicas/{replicaName}/restart' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['projectName', 'zone', 'poolName', 'replicaName'], - pathParams: ['poolName', 'projectName', 'replicaName', 'zone'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Replicas$Delete extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The replica pool name for this request. - */ - poolName?: string; - /** - * The project ID for this request. - */ - projectName?: string; - /** - * The name of the replica for this request. - */ - replicaName?: string; - /** - * The zone where the replica lives. - */ - zone?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$ReplicasDeleteRequest; - } - export interface Params$Resource$Replicas$Get extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The replica pool name for this request. - */ - poolName?: string; - /** - * The project ID for this request. - */ - projectName?: string; - /** - * The name of the replica for this request. - */ - replicaName?: string; - /** - * The zone where the replica lives. - */ - zone?: string; - } - export interface Params$Resource$Replicas$List extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Maximum count of results to be returned. Acceptable values are 0 to 100, inclusive. (Default: 50) - */ - maxResults?: number; - /** - * Set this to the nextPageToken value returned by a previous list request to obtain the next page of results from the previous list request. - */ - pageToken?: string; - /** - * The replica pool name for this request. - */ - poolName?: string; - /** - * The project ID for this request. - */ - projectName?: string; - /** - * The zone where the replica pool lives. - */ - zone?: string; - } - export interface Params$Resource$Replicas$Restart extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The replica pool name for this request. - */ - poolName?: string; - /** - * The project ID for this request. - */ - projectName?: string; - /** - * The name of the replica for this request. - */ - replicaName?: string; - /** - * The zone where the replica lives. - */ - zone?: string; - } -} diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index cba5c2d178..75351bf959 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -103,6 +103,7 @@ export namespace run_v1 { */ export class Run { context: APIRequestContext; + api: Resource$Api; namespaces: Resource$Namespaces; projects: Resource$Projects; @@ -112,6 +113,7 @@ export namespace run_v1 { google, }; + this.api = new Resource$Api(this.context); this.namespaces = new Resource$Namespaces(this.context); this.projects = new Resource$Projects(this.context); } @@ -496,23 +498,23 @@ export namespace run_v1 { command?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -1150,6 +1152,27 @@ export namespace run_v1 { */ url?: string | null; } + /** + * Cloud Run fully managed: not supported Cloud Run on GKE: supported Secret holds secret data of a certain type. The total bytes of the values in the Data field must be less than MaxSecretSize bytes. + */ + export interface Schema$Secret { + /** + * Data contains the secret data. Each key must consist of alphanumeric characters, '-', '_' or '.'. The serialized form of the secret data is a base64 encoded string, representing the arbitrary (possibly non-string) data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 + */ + data?: {[key: string]: string} | null; + /** + * Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata + */ + metadata?: Schema$ObjectMeta; + /** + * stringData allows specifying non-binary secret data in string form. It is provided as a write-only convenience method. All keys and values are merged into the data field on write, overwriting any existing values. It is never output when reading from the API. +k8s:conversion-gen=false + */ + stringData?: {[key: string]: string} | null; + /** + * Used to facilitate programmatic handling of secret data. + */ + type?: string | null; + } /** * Cloud Run fully managed: not supported Cloud Run for Anthos: supported SecretEnvSource selects a Secret to populate the environment variables with. The contents of the target Secret's Data field will represent the key-value pairs as environment variables. */ @@ -1476,6 +1499,299 @@ export namespace run_v1 { subPath?: string | null; } + export class Resource$Api { + context: APIRequestContext; + v1: Resource$Api$V1; + constructor(context: APIRequestContext) { + this.context = context; + this.v1 = new Resource$Api$V1(this.context); + } + } + + export class Resource$Api$V1 { + context: APIRequestContext; + namespaces: Resource$Api$V1$Namespaces; + constructor(context: APIRequestContext) { + this.context = context; + this.namespaces = new Resource$Api$V1$Namespaces(this.context); + } + } + + export class Resource$Api$V1$Namespaces { + context: APIRequestContext; + secrets: Resource$Api$V1$Namespaces$Secrets; + constructor(context: APIRequestContext) { + this.context = context; + this.secrets = new Resource$Api$V1$Namespaces$Secrets(this.context); + } + } + + export class Resource$Api$V1$Namespaces$Secrets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.api.v1.namespaces.secrets.create + * @desc Creates a new secret. + * @alias run.api.v1.namespaces.secrets.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project ID or project number in which this secret should be created. + * @param {().Secret} params.requestBody Request 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$Api$V1$Namespaces$Secrets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Api$V1$Namespaces$Secrets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Api$V1$Namespaces$Secrets$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Api$V1$Namespaces$Secrets$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Api$V1$Namespaces$Secrets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Api$V1$Namespaces$Secrets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/api/v1/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.api.v1.namespaces.secrets.get + * @desc Rpc to get information about a secret. + * @alias run.api.v1.namespaces.secrets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the secret being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Api$V1$Namespaces$Secrets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Api$V1$Namespaces$Secrets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Api$V1$Namespaces$Secrets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Api$V1$Namespaces$Secrets$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Api$V1$Namespaces$Secrets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Api$V1$Namespaces$Secrets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/api/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); + } + } + + /** + * run.api.v1.namespaces.secrets.replaceSecret + * @desc Rpc to replace a secret. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.api.v1.namespaces.secrets.replaceSecret + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the secret being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().Secret} params.requestBody Request 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 + */ + replaceSecret( + params?: Params$Resource$Api$V1$Namespaces$Secrets$Replacesecret, + options?: MethodOptions + ): GaxiosPromise; + replaceSecret( + params: Params$Resource$Api$V1$Namespaces$Secrets$Replacesecret, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceSecret( + params: Params$Resource$Api$V1$Namespaces$Secrets$Replacesecret, + callback: BodyResponseCallback + ): void; + replaceSecret(callback: BodyResponseCallback): void; + replaceSecret( + paramsOrCallback?: + | Params$Resource$Api$V1$Namespaces$Secrets$Replacesecret + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Api$V1$Namespaces$Secrets$Replacesecret; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Api$V1$Namespaces$Secrets$Replacesecret; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/api/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Api$V1$Namespaces$Secrets$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The project ID or project number in which this secret should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Api$V1$Namespaces$Secrets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the secret being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Api$V1$Namespaces$Secrets$Replacesecret + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the secret being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export class Resource$Namespaces { context: APIRequestContext; authorizeddomains: Resource$Namespaces$Authorizeddomains; @@ -3279,6 +3595,7 @@ export namespace run_v1 { domainmappings: Resource$Projects$Locations$Domainmappings; revisions: Resource$Projects$Locations$Revisions; routes: Resource$Projects$Locations$Routes; + secrets: Resource$Projects$Locations$Secrets; services: Resource$Projects$Locations$Services; constructor(context: APIRequestContext) { this.context = context; @@ -3293,78 +3610,10 @@ export namespace run_v1 { ); this.revisions = new Resource$Projects$Locations$Revisions(this.context); this.routes = new Resource$Projects$Locations$Routes(this.context); + this.secrets = new Resource$Projects$Locations$Secrets(this.context); this.services = new Resource$Projects$Locations$Services(this.context); } - /** - * run.projects.locations.get - * @desc Gets information about a location. - * @alias run.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://run.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); - } - } - /** * run.projects.locations.list * @desc Lists information about the supported locations for this service. @@ -3445,18 +3694,6 @@ export namespace run_v1 { } } - 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 { /** @@ -4739,6 +4976,272 @@ export namespace run_v1 { watch?: boolean; } + export class Resource$Projects$Locations$Secrets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.projects.locations.secrets.create + * @desc Creates a new secret. + * @alias run.projects.locations.secrets.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project ID or project number in which this secret should be created. + * @param {().Secret} params.requestBody Request 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$Secrets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Secrets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Secrets$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.secrets.get + * @desc Rpc to get information about a secret. + * @alias run.projects.locations.secrets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the secret being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Projects$Locations$Secrets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Secrets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Secrets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.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); + } + } + + /** + * run.projects.locations.secrets.replaceSecret + * @desc Rpc to replace a secret. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.secrets.replaceSecret + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the secret being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().Secret} params.requestBody Request 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 + */ + replaceSecret( + params?: Params$Resource$Projects$Locations$Secrets$Replacesecret, + options?: MethodOptions + ): GaxiosPromise; + replaceSecret( + params: Params$Resource$Projects$Locations$Secrets$Replacesecret, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceSecret( + params: Params$Resource$Projects$Locations$Secrets$Replacesecret, + callback: BodyResponseCallback + ): void; + replaceSecret(callback: BodyResponseCallback): void; + replaceSecret( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Secrets$Replacesecret + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Secrets$Replacesecret; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Secrets$Replacesecret; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Secrets$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The project ID or project number in which this secret should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Locations$Secrets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the secret being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Secrets$Replacesecret + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the secret being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export class Resource$Projects$Locations$Services { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/run/v1alpha1.ts b/src/apis/run/v1alpha1.ts index c262e82f9c..fabb9f7acb 100644 --- a/src/apis/run/v1alpha1.ts +++ b/src/apis/run/v1alpha1.ts @@ -196,32 +196,32 @@ export namespace run_v1alpha1 { */ drop?: string[] | null; } - export interface Schema$CloudAuditLog { + export interface Schema$CloudAuditLogsSource { /** * The API version for this call such as "events.cloud.google.com/v1alpha1". */ apiVersion?: string | null; /** - * The kind of resource, in this case "CloudAuditLog". + * The kind of resource, in this case "CloudAuditLogsSource". */ kind?: string | null; /** - * Metadata associated with this CloudAuditLog. + * Metadata associated with this CloudAuditLogsSource. */ metadata?: Schema$ObjectMeta; /** - * Spec defines the desired state of the CloudAuditLog. + * Spec defines the desired state of the CloudAuditLogsSource. */ - spec?: Schema$CloudAuditLogSpec; + spec?: Schema$CloudAuditLogsSourceSpec; /** - * Status represents the current state of the CloudAuditLog. This data may be out of date. +optional + * Status represents the current state of the CloudAuditLogsSource. This data may be out of date. +optional */ - status?: Schema$CloudAuditLogStatus; + status?: Schema$CloudAuditLogsSourceStatus; } /** - * The desired state of the CloudAuditLog. + * The desired state of the CloudAuditLogsSource. */ - export interface Schema$CloudAuditLogSpec { + export interface Schema$CloudAuditLogsSourceSpec { /** * CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional */ @@ -230,24 +230,12 @@ export namespace run_v1alpha1 { * Required. The method name at the service API. This must match "methodName" in Cloud Audit Logs. Regex or Wildcards (*) are not supported. Example: "google.cloud.bigquery.job.create". */ methodName?: string | null; - /** - * Project is the ID of the Google Cloud Project that the PubSub Topic exists in. If omitted, defaults to same as the cluster. +optional - */ - project?: string | null; - /** - * PubSubSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret. - */ - pubsubSecret?: Schema$SecretKeySelector; /** * Optional. The resource specification. This must match "methodName" in Cloud Audit Logs. Regex or Wildcards (*) are not supported. Example: "projects/my-project/jobs/foo". */ resourceName?: string | null; /** - * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional - */ - secret?: Schema$SecretKeySelector; - /** - * Email address of the IAM service account associated with the source. The service account represents the identity of the source, and determines what permissions the source has. If not provided, the source will use the project's default service account. +optional + * Optional. Email address of the IAM service account associated with the source. The service account represents the identity of the source, and determines what permissions the source has. If not provided, the source will use the project's default service account. */ serviceAccountName?: string | null; /** @@ -260,15 +248,15 @@ export namespace run_v1alpha1 { sink?: Schema$Destination; } /** - * CloudAuditLogStatus represents the current state of a CloudAuditLog. + * CloudAuditLogsSourceStatus represents the current state of a CloudAuditLogsSource. */ - export interface Schema$CloudAuditLogStatus { + export interface Schema$CloudAuditLogsSourceStatus { /** - * Array of observed CloudAuditLogConditions, indicating the current state of the CloudAuditLog. + * Array of observed CloudAuditLogsSourceConditions, indicating the current state of the CloudAuditLogsSource. */ conditions?: Schema$Condition[]; /** - * ObservedGeneration is the 'Generation' of the CloudAuditLog that was last processed by the controller. + * ObservedGeneration is the 'Generation' of the CloudAuditLogsSource that was last processed by the controller. */ observedGeneration?: number | null; /** @@ -285,6 +273,252 @@ export namespace run_v1alpha1 { */ extensions?: {[key: string]: string} | null; } + export interface Schema$CloudPubSubSource { + /** + * The API version for this call such as "events.cloud.google.com/v1alpha1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case "CloudPubSubSource". + */ + kind?: string | null; + /** + * Metadata associated with this CloudPubSubSource. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec defines the desired state of the CloudPubSubSource. + */ + spec?: Schema$CloudPubSubSourceSpec; + /** + * Status represents the current state of the CloudPubSubSource. This data may be out of date. +optional + */ + status?: Schema$CloudPubSubSourceStatus; + } + /** + * The desired state of the CloudPubSubSource. + */ + export interface Schema$CloudPubSubSourceSpec { + /** + * AckDeadline is the default maximum time after a subscriber receives a message before the subscriber should acknowledge the message. Defaults to 30 seconds ('30s'). +optional + */ + ackDeadline?: string | null; + /** + * CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional + */ + ceOverrides?: Schema$CloudEventOverrides; + /** + * Project is the ID of the Google Cloud Project that the CloudPubSubSource Topic exists in. If omitted, defaults to same as the cluster. +optional + */ + project?: string | null; + /** + * CloudPubSubSourceSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret. + */ + pubsubSecret?: Schema$SecretKeySelector; + /** + * RetainAckedMessages defines whether to retain acknowledged messages. If true, acknowledged messages will not be expunged until they fall out of the RetentionDuration window. + */ + retainAckedMessages?: boolean | null; + /** + * RetentionDuration defines how long to retain messages in backlog, from the time of publish. If RetainAckedMessages is true, this duration affects the retention of acknowledged messages, otherwise only unacknowledged messages are retained. Cannot be longer than 7 days or shorter than 10 minutes. Defaults to 7 days ('7d'). +optional + */ + retentionDuration?: string | null; + /** + * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional + */ + secret?: Schema$SecretKeySelector; + /** + * Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink. + */ + sink?: Schema$Destination; + /** + * Topic is the ID of the CloudPubSubSource Topic to Subscribe to. It must be in the form of the unique identifier within the project, not the entire name. E.g. it must be 'laconia', not 'projects/my-proj/topics/laconia'. + */ + topic?: string | null; + } + /** + * CloudPubSubSourceStatus represents the current state of a CloudPubSubSource. + */ + export interface Schema$CloudPubSubSourceStatus { + /** + * Array of observed CloudPubSubSourceConditions, indicating the current state of the CloudPubSubSource. + */ + conditions?: Schema$Condition[]; + /** + * ObservedGeneration is the 'Generation' of the CloudPubSubSource that was last processed by the controller. + */ + observedGeneration?: number | null; + /** + * SinkURI is the current active sink URI that has been configured for the Source. +optional + */ + sinkUri?: string | null; + } + /** + * The CloudSchedulerSource resource. + */ + export interface Schema$CloudSchedulerSource { + /** + * The API version for this call such as "events.cloud.google.com/v1alpha1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case "CloudSchedulerSource". + */ + kind?: string | null; + /** + * Metadata associated with this CloudSchedulerSource. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec defines the desired state of the CloudSchedulerSource. + */ + spec?: Schema$CloudSchedulerSourceSpec; + /** + * Status represents the current state of the CloudSchedulerSource. This data may be out of date. + */ + status?: Schema$CloudSchedulerSourceStatus; + } + /** + * The desired state of the CloudSchedulerSource. + */ + export interface Schema$CloudSchedulerSourceSpec { + /** + * CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. + */ + ceOverrides?: Schema$CloudEventOverrides; + /** + * Data to send in the payload of the Event. + */ + data?: string | null; + /** + * Location to create the Scheduler job in. + */ + location?: string | null; + /** + * Project is the ID of the Google Cloud Project that the CloudPubSubSource Topic exists in. If omitted, defaults to same as the cluster. + */ + project?: string | null; + /** + * CloudPubSubSourceSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret. + */ + pubsubSecret?: Schema$SecretKeySelector; + /** + * Schedule in cron format, for example: "* * * * *" would be run every minute. + */ + schedule?: string | null; + /** + * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json + */ + secret?: Schema$SecretKeySelector; + /** + * Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink. + */ + sink?: Schema$Destination; + } + /** + * CloudSchedulerSourceStatus represents the current state of a CloudSchedulerSource. + */ + export interface Schema$CloudSchedulerSourceStatus { + /** + * Array of observed CloudSchedulerSourceConditions, indicating the current state of the CloudSchedulerSource. + */ + conditions?: Schema$Condition[]; + /** + * ObservedGeneration is the 'Generation' of the CloudSchedulerSource that was last processed by the controller. + */ + observedGeneration?: number | null; + /** + * SinkURI is the current active sink URI that has been configured for the Source. + */ + sinkUri?: string | null; + } + /** + * The CloudStorageSource resource. + */ + export interface Schema$CloudStorageSource { + /** + * The API version for this call such as "events.cloud.google.com/v1alpha1". + */ + apiVersion?: string | null; + /** + * The kind of resource, in this case "CloudStorageSource". + */ + kind?: string | null; + /** + * Metadata associated with this CloudStorageSource. + */ + metadata?: Schema$ObjectMeta; + /** + * Spec defines the desired state of the CloudStorageSource. + */ + spec?: Schema$CloudStorageSourceSpec; + /** + * Status represents the current state of the CloudStorageSource. This data may be out of date. + */ + status?: Schema$CloudStorageSourceStatus; + } + /** + * The desired state of the CloudStorageSource. + */ + export interface Schema$CloudStorageSourceSpec { + /** + * Bucket to subscribe to. + */ + bucket?: string | null; + /** + * CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. + */ + ceOverrides?: Schema$CloudEventOverrides; + /** + * EventTypes to subscribe to. If unspecified, then subscribe to all events. + */ + eventTypes?: string[] | null; + /** + * ObjectNamePrefix limits the notifications to objects with this prefix. + */ + objectNamePrefix?: string | null; + /** + * PayloadFormat specifies the contents of the message payload. See https://cloud.google.com/storage/docs/pubsub-notifications#payload. + */ + payloadFormat?: string | null; + /** + * Project is the ID of the Google Cloud Project that the PubSub Topic exists in. If omitted, defaults to same as the cluster. + */ + project?: string | null; + /** + * PubSubSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret. + */ + pubsubSecret?: Schema$SecretKeySelector; + /** + * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json + */ + secret?: Schema$SecretKeySelector; + /** + * ServiceAccountName holds the name of the Kubernetes service account as which the underlying K8s resources should be run. If unspecified this will default to the "default" service account for the namespace in which the GCS exists. + */ + serviceAccountName?: string | null; + /** + * Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink. + */ + sink?: Schema$Destination; + } + /** + * CloudStorageSourceStatus represents the current state of a CloudStorageSource. + */ + export interface Schema$CloudStorageSourceStatus { + /** + * Array of observed CloudStorageSourceConditions, indicating the current state of the CloudStorageSource. + */ + conditions?: Schema$Condition[]; + /** + * ObservedGeneration is the 'Generation' of the CloudStorageSource that was last processed by the controller. + */ + observedGeneration?: number | null; + /** + * SinkURI is the current active sink URI that has been configured for the Source. + */ + sinkUri?: string | null; + } /** * Condition defines a generic condition for a Resource */ @@ -732,74 +966,6 @@ export namespace run_v1alpha1 { */ secretKeyRef?: Schema$SecretKeySelector; } - export interface Schema$EventType { - /** - * The API version for this call such as "eventing.knative.dev/v1alpha1". - */ - apiVersion?: string | null; - /** - * The kind of resource, in this case "EventType". - */ - kind?: string | null; - /** - * Metadata associated with this EventType. - */ - metadata?: Schema$ObjectMeta; - /** - * Spec defines the desired state of the EventType. - */ - spec?: Schema$EventTypeSpec; - } - export interface Schema$EventTypeImporter { - /** - * The API version of the importer CRD. - */ - apiVersion?: string | null; - /** - * The kind of the importer CRD. - */ - kind?: string | null; - /** - * Parameters required to create an importer for the EventType. - */ - parameters?: Schema$EventTypeParameter[]; - } - export interface Schema$EventTypeParameter { - /** - * Description of the parameter. E.g. "Google Cloud Project Id." - */ - description?: string | null; - /** - * Name of the parameter. E.g. googleCloudProject. - */ - name?: string | null; - } - export interface Schema$EventTypeSpec { - /** - * Refers to the Broker that can provide the EventType. - */ - broker?: string | null; - /** - * Description is a string describing what the EventType is about. +optional - */ - description?: string | null; - /** - * The importer that provides this EventType to the eventing mesh. - */ - importer?: Schema$EventTypeImporter; - /** - * Schema is a URI with the EventType schema. It may be a JSON schema, a protobuf schema, etc. +optional - */ - schema?: string | null; - /** - * Source is a valid URI. Refers to the CloudEvent source as it enters into the eventing mesh. - */ - source?: string | null; - /** - * Type is authoritative. This refers to the CloudEvent type as it enters into the eventing mesh. - */ - type?: string | null; - } /** * ExecAction describes a "run in container" action. */ @@ -810,23 +976,23 @@ export namespace run_v1alpha1 { command?: string | null; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -885,24 +1051,6 @@ export namespace run_v1alpha1 { */ value?: string | null; } - /** - * Initializer is information about an initializer that has not yet completed. - */ - export interface Schema$Initializer { - /** - * name of the process that is responsible for initializing this object. - */ - name?: string | null; - } - /** - * Initializers tracks the progress of initialization. - */ - export interface Schema$Initializers { - /** - * Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients. +patchMergeKey=name +patchStrategy=merge - */ - pending?: Schema$Initializer[]; - } /** * IntOrString is a type that can hold an int32 or a string. When used in JSON or YAML marshalling and unmarshalling, it produces or consumes the inner type. This allows you to have, for example, a JSON field that can accept a name or number. */ @@ -964,23 +1112,23 @@ export namespace run_v1alpha1 { nextPageToken?: string | null; } /** - * ListCloudAuditLogsResponse is a list of CloudAuditLog resources. + * ListCloudAuditLogsSourcesResponse is a list of CloudAuditLogsSource resources. */ - export interface Schema$ListCloudAuditLogsResponse { + export interface Schema$ListCloudAuditLogsSourcesResponse { /** * The API version for this call such as "events.cloud.google.com/v1alpha1". */ apiVersion?: string | null; /** - * List of CloudAuditLogs. + * List of CloudAuditLogsSources. */ - items?: Schema$CloudAuditLog[]; + items?: Schema$CloudAuditLogsSource[]; /** - * The kind of this resource, in this case "CloudAuditLogList". + * The kind of this resource, in this case "CloudAuditLogsSourceList". */ kind?: string | null; /** - * Metadata associated with this CloudAuditLog list. + * Metadata associated with this CloudAuditLogsSource list. */ metadata?: Schema$ListMeta; /** @@ -989,23 +1137,23 @@ export namespace run_v1alpha1 { unreachable?: string[] | null; } /** - * ListConfigurationsResponse is a list of Configuration resources. + * ListCloudPubSubSourcesResponse is a list of CloudPubSubSource resources. */ - export interface Schema$ListConfigurationsResponse { + export interface Schema$ListCloudPubSubSourcesResponse { /** - * The API version for this call such as "serving.knative.dev/v1alpha1". + * The API version for this call such as "events.cloud.google.com/v1alpha1". */ apiVersion?: string | null; /** - * List of Configurations. + * List of CloudPubSubSources. */ - items?: Schema$Configuration[]; + items?: Schema$CloudPubSubSource[]; /** - * The kind of this resource, in this case "ConfigurationList". + * The kind of this resource, in this case "CloudPubSubSourceList". */ kind?: string | null; /** - * Metadata associated with this Configuration list. + * Metadata associated with this CloudPubSubSource list. */ metadata?: Schema$ListMeta; /** @@ -1014,23 +1162,23 @@ export namespace run_v1alpha1 { unreachable?: string[] | null; } /** - * ListDomainMappingsResponse is a list of DomainMapping resources. + * ListCloudSchedulerSourcesResponse is a list of CloudSchedulerSource resources. */ - export interface Schema$ListDomainMappingsResponse { + export interface Schema$ListCloudSchedulerSourcesResponse { /** - * The API version for this call such as "domains.cloudrun.com/v1alpha1". + * The API version for this call such as "events.cloud.google.com/v1alpha1". */ apiVersion?: string | null; /** - * List of DomainMappings. + * List of CloudSchedulerSources. */ - items?: Schema$DomainMapping[]; + items?: Schema$CloudSchedulerSource[]; /** - * The kind of this resource, in this case "DomainMappingList". + * The kind of this resource, in this case "CloudSchedulerSourceList". */ kind?: string | null; /** - * Metadata associated with this DomainMapping list. + * Metadata associated with this CloudSchedulerSource list. */ metadata?: Schema$ListMeta; /** @@ -1039,23 +1187,23 @@ export namespace run_v1alpha1 { unreachable?: string[] | null; } /** - * ListEventTypesResponse is a list of EventType resources. + * ListCloudStorageSourcesResponse is a list of CloudStorageSource resources. */ - export interface Schema$ListEventTypesResponse { + export interface Schema$ListCloudStorageSourcesResponse { /** - * The API version for this call such as "eventing.knative.dev/v1alpha1". + * The API version for this call such as "events.cloud.google.com/v1alpha1". */ apiVersion?: string | null; /** - * List of EventTypes. + * List of CloudStorageSources. */ - items?: Schema$EventType[]; + items?: Schema$CloudStorageSource[]; /** - * The kind of this resource, in this case "EventTypeList". + * The kind of this resource, in this case "CloudStorageSourceList". */ kind?: string | null; /** - * Metadata associated with this EventType list. + * Metadata associated with this CloudStorageSource list. */ metadata?: Schema$ListMeta; /** @@ -1064,53 +1212,48 @@ export namespace run_v1alpha1 { unreachable?: string[] | null; } /** - * The response message for Locations.ListLocations. + * ListConfigurationsResponse is a list of Configuration resources. */ - export interface Schema$ListLocationsResponse { + export interface Schema$ListConfigurationsResponse { /** - * A list of locations that matches the specified filter in the request. + * The API version for this call such as "serving.knative.dev/v1alpha1". */ - locations?: Schema$Location[]; + apiVersion?: string | null; /** - * The standard List next-page token. + * List of Configurations. */ - nextPageToken?: string | null; - } - /** - * ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. - */ - export interface Schema$ListMeta { + items?: Schema$Configuration[]; /** - * continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. + * The kind of this resource, in this case "ConfigurationList". */ - continue?: string | null; + kind?: string | null; /** - * String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional + * Metadata associated with this Configuration list. */ - resourceVersion?: string | null; + metadata?: Schema$ListMeta; /** - * SelfLink is a URL representing this object. Populated by the system. Read-only. +optional + * Locations that could not be reached. */ - selfLink?: string | null; + unreachable?: string[] | null; } /** - * ListPubSubsResponse is a list of PubSub resources. + * ListDomainMappingsResponse is a list of DomainMapping resources. */ - export interface Schema$ListPubSubsResponse { + export interface Schema$ListDomainMappingsResponse { /** - * The API version for this call such as "events.cloud.google.com/v1alpha1". + * The API version for this call such as "domains.cloudrun.com/v1alpha1". */ apiVersion?: string | null; /** - * List of PubSubs. + * List of DomainMappings. */ - items?: Schema$PubSub[]; + items?: Schema$DomainMapping[]; /** - * The kind of this resource, in this case "PubSubList". + * The kind of this resource, in this case "DomainMappingList". */ kind?: string | null; /** - * Metadata associated with this PubSub list. + * Metadata associated with this DomainMapping list. */ metadata?: Schema$ListMeta; /** @@ -1118,6 +1261,36 @@ export namespace run_v1alpha1 { */ unreachable?: string[] | null; } + /** + * 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 | null; + } + /** + * ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}. + */ + export interface Schema$ListMeta { + /** + * continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response. + */ + continue?: string | null; + /** + * String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency +optional + */ + resourceVersion?: string | null; + /** + * SelfLink is a URL representing this object. Populated by the system. Read-only. +optional + */ + selfLink?: string | null; + } /** * ListRevisionsResponse is a list of Revision resources. */ @@ -1193,31 +1366,6 @@ export namespace run_v1alpha1 { */ unreachable?: string[] | null; } - /** - * ListStoragesResponse is a list of Storage resources. - */ - export interface Schema$ListStoragesResponse { - /** - * The API version for this call such as "events.cloud.google.com/v1alpha1". - */ - apiVersion?: string | null; - /** - * List of Storages. - */ - items?: Schema$Storage[]; - /** - * The kind of this resource, in this case "StorageList". - */ - kind?: string | null; - /** - * Metadata associated with this Storage list. - */ - metadata?: Schema$ListMeta; - /** - * Locations that could not be reached. - */ - unreachable?: string[] | null; - } /** * ListTriggersResponse is a list of Trigger resources. */ @@ -1313,10 +1461,6 @@ export namespace run_v1alpha1 { * A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +optional */ generation?: number | null; - /** - * Not currently supported by Cloud Run. An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects. When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user. - */ - initializers?: Schema$Initializers; /** * Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels +optional */ @@ -1458,90 +1602,6 @@ export namespace run_v1alpha1 { */ timeoutSeconds?: number | null; } - export interface Schema$PubSub { - /** - * The API version for this call such as "events.cloud.google.com/v1alpha1". - */ - apiVersion?: string | null; - /** - * The kind of resource, in this case "PubSub". - */ - kind?: string | null; - /** - * Metadata associated with this PubSub. - */ - metadata?: Schema$ObjectMeta; - /** - * Spec defines the desired state of the PubSub. - */ - spec?: Schema$PubSubSpec; - /** - * Status represents the current state of the PubSub. This data may be out of date. +optional - */ - status?: Schema$PubSubStatus; - } - /** - * The desired state of the PubSub. - */ - export interface Schema$PubSubSpec { - /** - * AckDeadline is the default maximum time after a subscriber receives a message before the subscriber should acknowledge the message. Defaults to 30 seconds ('30s'). +optional - */ - ackDeadline?: string | null; - /** - * CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional - */ - ceOverrides?: Schema$CloudEventOverrides; - /** - * Project is the ID of the Google Cloud Project that the PubSub Topic exists in. If omitted, defaults to same as the cluster. +optional - */ - project?: string | null; - /** - * PubSubSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret. - */ - pubsubSecret?: Schema$SecretKeySelector; - /** - * RetainAckedMessages defines whether to retain acknowledged messages. If true, acknowledged messages will not be expunged until they fall out of the RetentionDuration window. - */ - retainAckedMessages?: boolean | null; - /** - * RetentionDuration defines how long to retain messages in backlog, from the time of publish. If RetainAckedMessages is true, this duration affects the retention of acknowledged messages, otherwise only unacknowledged messages are retained. Cannot be longer than 7 days or shorter than 10 minutes. Defaults to 7 days ('7d'). +optional - */ - retentionDuration?: string | null; - /** - * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional - */ - secret?: Schema$SecretKeySelector; - /** - * Email address of the IAM service account associated with the source. The service account represents the identity of the source, and determines what permissions the source has. If not provided, the source will use the project's Compute Engine default service account. +optional - */ - serviceAccountName?: string | null; - /** - * Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink. - */ - sink?: Schema$Destination; - /** - * Topic is the ID of the PubSub Topic to Subscribe to. It must be in the form of the unique identifier within the project, not the entire name. E.g. it must be 'laconia', not 'projects/my-proj/topics/laconia'. - */ - topic?: string | null; - } - /** - * PubSubStatus represents the current state of a PubSub. - */ - export interface Schema$PubSubStatus { - /** - * Array of observed PubSubConditions, indicating the current state of the PubSub. - */ - conditions?: Schema$Condition[]; - /** - * ObservedGeneration is the 'Generation' of the PubSub that was last processed by the controller. - */ - observedGeneration?: number | null; - /** - * SinkURI is the current active sink URI that has been configured for the Source. +optional - */ - sinkUri?: string | null; - } /** * The view model of a single quantity, e.g. "800 MiB". Corresponds to https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/generated.proto */ @@ -2116,96 +2176,6 @@ export namespace run_v1alpha1 { */ updateMask?: string | null; } - export interface Schema$Storage { - /** - * The API version for this call such as "events.cloud.google.com/v1alpha1". - */ - apiVersion?: string | null; - /** - * The kind of resource, in this case "Storage". - */ - kind?: string | null; - /** - * Metadata associated with this Storage. - */ - metadata?: Schema$ObjectMeta; - /** - * Spec defines the desired state of the Storage. - */ - spec?: Schema$StorageSpec; - /** - * Status represents the current state of the Storage. This data may be out of date. +optional - */ - status?: Schema$StorageStatus; - } - /** - * The desired state of the Storage. - */ - export interface Schema$StorageSpec { - /** - * Bucket to subscribe to. - */ - bucket?: string | null; - /** - * CloudEventOverrides defines overrides to control the output format and modifications of the event sent to the sink. +optional - */ - ceOverrides?: Schema$CloudEventOverrides; - /** - * EventTypes to subscribe to. If unspecified, then subscribe to all events. +optional - */ - eventTypes?: string[] | null; - /** - * ObjectNamePrefix limits the notifications to objects with this prefix +optional - */ - objectNamePrefix?: string | null; - /** - * PayloadFormat specifies the contents of the message payload. See https://cloud.google.com/storage/docs/pubsub-notifications#payload. +optional - */ - payloadFormat?: string | null; - /** - * Project is the ID of the Google Cloud Project that the PubSub Topic exists in. If omitted, defaults to same as the cluster. +optional - */ - project?: string | null; - /** - * PubSubSecret is the credential to use to create Topic / PullSubscription resources. If omitted, uses Secret. - */ - pubsubSecret?: Schema$SecretKeySelector; - /** - * Secret is the credential to use to create the Scheduler Job. If not specified, defaults to: Name: google-cloud-key Key: key.json +optional - */ - secret?: Schema$SecretKeySelector; - /** - * ServiceAccountName holds the name of the Kubernetes service account as which the underlying K8s resources should be run. If unspecified this will default to the "default" service account for the namespace in which the GCS exists. +optional - */ - serviceAccountName?: string | null; - /** - * Sink is a reference to an object that will resolve to a domain name or a URI directly to use as the sink. - */ - sink?: Schema$Destination; - } - /** - * StorageStatus represents the current state of a Storage. - */ - export interface Schema$StorageStatus { - /** - * Array of observed StorageConditions, indicating the current state of the Storage. - */ - conditions?: Schema$Condition[]; - /** - * ObservedGeneration is the 'Generation' of the Storage that was last processed by the controller. - */ - observedGeneration?: number | null; - } - export interface Schema$SubscriberSpec { - /** - * Reference to an object that will be used to find the target endpoint, which should implement the Addressable duck type. For example, this could be a reference to a Route resource or a Knative Service resource. - */ - ref?: Schema$ObjectReference; - /** - * Reference to a 'known' endpoint where no resolving is done. http://k8s-service for example http://myexternalhandler.example.com/foo/bar - */ - uri?: string | null; - } /** * TCPSocketAction describes an action based on opening a socket */ @@ -2288,7 +2258,7 @@ export namespace run_v1alpha1 { */ spec?: Schema$TriggerSpec; /** - * Status represents the current state of the Trigger. This data may be out of date. +optional + * Optional. Status represents the current state of the Trigger. This data may be out of date. */ status?: Schema$TriggerStatus; } @@ -2297,19 +2267,19 @@ export namespace run_v1alpha1 { */ export interface Schema$TriggerCondition { /** - * Last time the condition transitioned from one status to another. +optional + * Optional. Last time the condition transitioned from one status to another. */ lastTransitionTime?: string | null; /** - * Human readable message indicating details about the current status. +optional + * Optional. Human readable message indicating details about the current status. */ message?: string | null; /** - * One-word CamelCase reason for the condition's current status. +optional + * Optional. One-word CamelCase reason for the condition's current status. */ reason?: string | null; /** - * How to interpret failures of this condition, one of Error, Warning, Info +optional + * Optional. How to interpret failures of this condition, one of Error, Warning, Info */ severity?: string | null; /** @@ -2323,58 +2293,26 @@ export namespace run_v1alpha1 { } export interface Schema$TriggerFilter { /** - * Cloud Run fully managed: not supported Cloud Run on GKE: supported Attributes filters events by exact match on event context attributes. Each key in the map is compared with the equivalent key in the event context. An event passes the filter if all values are equal to the specified values. Nested context attributes are not supported as keys. Only string values are supported. +optional + * Optional. Attributes filters events by exact match on event context attributes. Each key in the map is compared with the equivalent key in the event context. An event passes the filter if all values are equal to the specified values. Nested context attributes are not supported as keys. Only string values are supported. Note that this field is optional in knative. In fully managed, 'type' attribute is required due to different broker implementation. */ attributes?: {[key: string]: string} | null; - /** - * SourceAndType is DEPRECATED and replaced by the Attributes field. - */ - sourceAndType?: Schema$TriggerFilterSourceAndType; - } - /** - * TriggerFilterSourceAndType is DEPRECATED. Filters are now contained in the map of attributes in TriggerFilter proto. - */ - export interface Schema$TriggerFilterSourceAndType { - source?: string | null; - type?: string | null; } /** - * Deprecated, importer specification will be available via GcpImporterDao. + * The desired state of the Trigger. */ - export interface Schema$TriggerImporterSpec { + export interface Schema$TriggerSpec { /** - * Arguments to use for the importer. These must match the parameters in the EventType's importer. + * Broker is the broker that this trigger receives events from. If not specified, will default to 'default'. Not currently supported by Cloud Run. */ - arguments?: {[key: string]: string} | null; + broker?: string | null; /** - * Name of the EventType that this importer provides. - */ - eventTypeName?: string | null; - } - /** - * The desired state of the Trigger. - */ - export interface Schema$TriggerSpec { - /** - * Broker is the broker that this trigger receives events from. If not specified, will default to 'default'. Not currently supported by Cloud Run. - */ - broker?: string | null; - /** - * Filter is the filter to apply against all events from the Broker. Only events that pass this filter will be sent to the Subscriber. + * Optional. Filter is the filter to apply against all events from the Broker. Only events that pass this filter will be sent to the Subscriber. Note that filter is optional in knative and is only required in fully managed due to different broker implementation. */ filter?: Schema$TriggerFilter; - /** - * Deprecated, importer specification will be replaced by information stored in GcpImporterDao. - */ - importers?: Schema$TriggerImporterSpec[]; /** * Sink is the addressable that will receive events. */ - sink?: Schema$Destination; - /** - * Deprecated, sink will be represented by Destination. Subscriber is the addressable that receives events from the Broker that pass the Filter. It is required. E.g. https://us-central1-myproject.cloudfunctions.net/myfunction or /namespaces/my-project/services/my-service. - */ - subscriber?: Schema$SubscriberSpec; + subscriber?: Schema$Destination; } /** * TriggerStatus represents the current state of a Trigger. @@ -2446,22 +2384,31 @@ export namespace run_v1alpha1 { export class Resource$Namespaces { context: APIRequestContext; authorizeddomains: Resource$Namespaces$Authorizeddomains; - cloudauditlogs: Resource$Namespaces$Cloudauditlogs; + cloudauditlogssources: Resource$Namespaces$Cloudauditlogssources; + cloudpubsubsources: Resource$Namespaces$Cloudpubsubsources; + cloudschedulersources: Resource$Namespaces$Cloudschedulersources; + cloudstoragesources: Resource$Namespaces$Cloudstoragesources; configurations: Resource$Namespaces$Configurations; domainmappings: Resource$Namespaces$Domainmappings; - eventtypes: Resource$Namespaces$Eventtypes; - pubsubs: Resource$Namespaces$Pubsubs; revisions: Resource$Namespaces$Revisions; routes: Resource$Namespaces$Routes; services: Resource$Namespaces$Services; - storages: Resource$Namespaces$Storages; triggers: Resource$Namespaces$Triggers; constructor(context: APIRequestContext) { this.context = context; this.authorizeddomains = new Resource$Namespaces$Authorizeddomains( this.context ); - this.cloudauditlogs = new Resource$Namespaces$Cloudauditlogs( + this.cloudauditlogssources = new Resource$Namespaces$Cloudauditlogssources( + this.context + ); + this.cloudpubsubsources = new Resource$Namespaces$Cloudpubsubsources( + this.context + ); + this.cloudschedulersources = new Resource$Namespaces$Cloudschedulersources( + this.context + ); + this.cloudstoragesources = new Resource$Namespaces$Cloudstoragesources( this.context ); this.configurations = new Resource$Namespaces$Configurations( @@ -2470,12 +2417,9 @@ export namespace run_v1alpha1 { this.domainmappings = new Resource$Namespaces$Domainmappings( this.context ); - this.eventtypes = new Resource$Namespaces$Eventtypes(this.context); - this.pubsubs = new Resource$Namespaces$Pubsubs(this.context); this.revisions = new Resource$Namespaces$Revisions(this.context); this.routes = new Resource$Namespaces$Routes(this.context); this.services = new Resource$Namespaces$Services(this.context); - this.storages = new Resource$Namespaces$Storages(this.context); this.triggers = new Resource$Namespaces$Triggers(this.context); } } @@ -2593,55 +2537,57 @@ export namespace run_v1alpha1 { parent?: string; } - export class Resource$Namespaces$Cloudauditlogs { + export class Resource$Namespaces$Cloudauditlogssources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.cloudauditlogs.create - * @desc Creates a new cloudauditlog. - * @alias run.namespaces.cloudauditlogs.create + * run.namespaces.cloudauditlogssources.create + * @desc Creates a new cloudauditlogssource. + * @alias run.namespaces.cloudauditlogssources.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this cloudauditlog should be created. - * @param {().CloudAuditLog} params.requestBody Request body data + * @param {string} params.parent The project ID or project number in which this cloudauditlogssource should be created. + * @param {().CloudAuditLogsSource} params.requestBody Request 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$Namespaces$Cloudauditlogs$Create, + params?: Params$Resource$Namespaces$Cloudauditlogssources$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Namespaces$Cloudauditlogs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudauditlogssources$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Namespaces$Cloudauditlogs$Create, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudauditlogssources$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Namespaces$Cloudauditlogs$Create - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudauditlogssources$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Cloudauditlogs$Create; + {}) as Params$Resource$Namespaces$Cloudauditlogssources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Cloudauditlogs$Create; + params = {} as Params$Resource$Namespaces$Cloudauditlogssources$Create; options = {}; } @@ -2656,7 +2602,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudauditlogs' + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudauditlogssources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -2668,55 +2614,55 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.cloudauditlogs.delete - * @desc Rpc to delete a cloudauditlog. - * @alias run.namespaces.cloudauditlogs.delete + * run.namespaces.cloudauditlogssources.delete + * @desc Rpc to delete a cloudauditlogssource. + * @alias run.namespaces.cloudauditlogssources.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the cloudauditlog being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the cloudauditlogssource being deleted. If needed, replace {namespace_id} with the project ID. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [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$Namespaces$Cloudauditlogs$Delete, + params?: Params$Resource$Namespaces$Cloudauditlogssources$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Namespaces$Cloudauditlogs$Delete, + params: Params$Resource$Namespaces$Cloudauditlogssources$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Namespaces$Cloudauditlogs$Delete, + params: Params$Resource$Namespaces$Cloudauditlogssources$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Namespaces$Cloudauditlogs$Delete + | Params$Resource$Namespaces$Cloudauditlogssources$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Cloudauditlogs$Delete; + {}) as Params$Resource$Namespaces$Cloudauditlogssources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Cloudauditlogs$Delete; + params = {} as Params$Resource$Namespaces$Cloudauditlogssources$Delete; options = {}; } @@ -2749,47 +2695,49 @@ export namespace run_v1alpha1 { } /** - * run.namespaces.cloudauditlogs.get - * @desc Rpc to get information about a cloudauditlog. - * @alias run.namespaces.cloudauditlogs.get + * run.namespaces.cloudauditlogssources.get + * @desc Rpc to get information about a cloudauditlogssource. + * @alias run.namespaces.cloudauditlogssources.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the cloudauditlogssource being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Namespaces$Cloudauditlogs$Get, + params?: Params$Resource$Namespaces$Cloudauditlogssources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Cloudauditlogs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudauditlogssources$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Cloudauditlogs$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudauditlogssources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Cloudauditlogs$Get - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudauditlogssources$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Cloudauditlogs$Get; + {}) as Params$Resource$Namespaces$Cloudauditlogssources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Cloudauditlogs$Get; + params = {} as Params$Resource$Namespaces$Cloudauditlogssources$Get; options = {}; } @@ -2815,16 +2763,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.cloudauditlogs.list - * @desc Rpc to list cloudauditlogs. - * @alias run.namespaces.cloudauditlogs.list + * run.namespaces.cloudauditlogssources.list + * @desc Rpc to list cloudauditlogssources. + * @alias run.namespaces.cloudauditlogssources.list * @memberOf! () * * @param {object} params Parameters for request @@ -2833,7 +2781,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the cloudauditlogs should be listed. + * @param {string} params.parent The project ID or project number from which the cloudauditlogssources should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2841,39 +2789,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Cloudauditlogs$List, + params?: Params$Resource$Namespaces$Cloudauditlogssources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Cloudauditlogs$List, + params: Params$Resource$Namespaces$Cloudauditlogssources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Cloudauditlogs$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudauditlogssources$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Cloudauditlogs$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudauditlogssources$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Cloudauditlogs$List; + {}) as Params$Resource$Namespaces$Cloudauditlogssources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Cloudauditlogs$List; + params = {} as Params$Resource$Namespaces$Cloudauditlogssources$List; options = {}; } @@ -2888,7 +2836,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudauditlogs' + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudauditlogssources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -2900,93 +2848,19 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.cloudauditlogs.replaceCloudAuditLog - * @desc Rpc to replace a cloudauditlog. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.namespaces.cloudauditlogs.replaceCloudAuditLog - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().CloudAuditLog} params.requestBody Request 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 - */ - replaceCloudAuditLog( - params?: Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog, - options?: MethodOptions - ): GaxiosPromise; - replaceCloudAuditLog( - params: Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceCloudAuditLog( - params: Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog, - callback: BodyResponseCallback - ): void; - replaceCloudAuditLog( - callback: BodyResponseCallback - ): void; - replaceCloudAuditLog( - paramsOrCallback?: - | Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Namespaces$Cloudauditlogs$Create + export interface Params$Resource$Namespaces$Cloudauditlogssources$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -2994,16 +2868,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this cloudauditlog should be created. + * The project ID or project number in which this cloudauditlogssource should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$CloudAuditLog; + requestBody?: Schema$CloudAuditLogsSource; } - export interface Params$Resource$Namespaces$Cloudauditlogs$Delete + export interface Params$Resource$Namespaces$Cloudauditlogssources$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -3019,7 +2893,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the cloudauditlog being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the cloudauditlogssource being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** @@ -3027,7 +2901,7 @@ export namespace run_v1alpha1 { */ propagationPolicy?: string; } - export interface Params$Resource$Namespaces$Cloudauditlogs$Get + export interface Params$Resource$Namespaces$Cloudauditlogssources$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -3035,11 +2909,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the cloudauditlogssource being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Cloudauditlogs$List + export interface Params$Resource$Namespaces$Cloudauditlogssources$List extends StandardParameters { /** * Auth client or API Key for the request @@ -3067,7 +2941,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the cloudauditlogs should be listed. + * The project ID or project number from which the cloudauditlogssources should be listed. */ parent?: string; /** @@ -3079,72 +2953,204 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Namespaces$Cloudauditlogs$Replacecloudauditlog - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + export class Resource$Namespaces$Cloudpubsubsources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. + * run.namespaces.cloudpubsubsources.create + * @desc Creates a new cloudpubsubsource. + * @alias run.namespaces.cloudpubsubsources.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this cloudpubsubsource should be created. + * @param {().CloudPubSubSource} params.requestBody Request 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 */ - name?: string; + create( + params?: Params$Resource$Namespaces$Cloudpubsubsources$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Cloudpubsubsources$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Namespaces$Cloudpubsubsources$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Namespaces$Cloudpubsubsources$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Cloudpubsubsources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Cloudpubsubsources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudpubsubsources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } /** - * Request body metadata + * run.namespaces.cloudpubsubsources.delete + * @desc Rpc to delete a cloudpubsubsource. + * @alias run.namespaces.cloudpubsubsources.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the cloudpubsubsource being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object */ - requestBody?: Schema$CloudAuditLog; - } + delete( + params?: Params$Resource$Namespaces$Cloudpubsubsources$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Cloudpubsubsources$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Cloudpubsubsources$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Cloudpubsubsources$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Cloudpubsubsources$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Namespaces$Configurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Cloudpubsubsources$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } } /** - * run.namespaces.configurations.get - * @desc Rpc to get information about a configuration. - * @alias run.namespaces.configurations.get + * run.namespaces.cloudpubsubsources.get + * @desc Rpc to get information about a cloudpubsubsource. + * @alias run.namespaces.cloudpubsubsources.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the cloudpubsubsource being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Namespaces$Configurations$Get, + params?: Params$Resource$Namespaces$Cloudpubsubsources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Configurations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudpubsubsources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Configurations$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudpubsubsources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Configurations$Get - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudpubsubsources$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Configurations$Get; + {}) as Params$Resource$Namespaces$Cloudpubsubsources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Configurations$Get; + params = {} as Params$Resource$Namespaces$Cloudpubsubsources$Get; options = {}; } @@ -3158,7 +3164,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3170,16 +3176,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.configurations.list - * @desc Rpc to list configurations. - * @alias run.namespaces.configurations.list + * run.namespaces.cloudpubsubsources.list + * @desc Rpc to list cloudpubsubsources. + * @alias run.namespaces.cloudpubsubsources.list * @memberOf! () * * @param {object} params Parameters for request @@ -3188,7 +3194,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the configurations should be listed. + * @param {string} params.parent The project ID or project number from which the cloudpubsubsources should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3196,39 +3202,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Configurations$List, + params?: Params$Resource$Namespaces$Cloudpubsubsources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Configurations$List, + params: Params$Resource$Namespaces$Cloudpubsubsources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Configurations$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudpubsubsources$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Configurations$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudpubsubsources$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Configurations$List; + {}) as Params$Resource$Namespaces$Cloudpubsubsources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Configurations$List; + params = {} as Params$Resource$Namespaces$Cloudpubsubsources$List; options = {}; } @@ -3243,7 +3249,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/serving.knative.dev/v1alpha1/{+parent}/configurations' + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudpubsubsources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3255,17 +3261,19 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Namespaces$Configurations$Get + export interface Params$Resource$Namespaces$Cloudpubsubsources$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -3273,12 +3281,53 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. + * The project ID or project number in which this cloudpubsubsource should be created. */ - name?: string; - } - export interface Params$Resource$Namespaces$Configurations$List - extends StandardParameters { + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudPubSubSource; + } + export interface Params$Resource$Namespaces$Cloudpubsubsources$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the cloudpubsubsource being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Namespaces$Cloudpubsubsources$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the cloudpubsubsource being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Namespaces$Cloudpubsubsources$List + extends StandardParameters { /** * Auth client or API Key for the request */ @@ -3305,7 +3354,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the configurations should be listed. + * The project ID or project number from which the cloudpubsubsources should be listed. */ parent?: string; /** @@ -3318,55 +3367,57 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Namespaces$Domainmappings { + export class Resource$Namespaces$Cloudschedulersources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.domainmappings.create - * @desc Creates a new domain mapping. - * @alias run.namespaces.domainmappings.create + * run.namespaces.cloudschedulersources.create + * @desc Creates a new cloudschedulersource. + * @alias run.namespaces.cloudschedulersources.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this domain mapping should be created. - * @param {().DomainMapping} params.requestBody Request body data + * @param {string} params.parent Required. The project ID or project number in which this cloudschedulersource should be created. + * @param {().CloudSchedulerSource} params.requestBody Request 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$Namespaces$Domainmappings$Create, + params?: Params$Resource$Namespaces$Cloudschedulersources$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Namespaces$Domainmappings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudschedulersources$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Namespaces$Domainmappings$Create, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudschedulersources$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Namespaces$Domainmappings$Create - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudschedulersources$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Domainmappings$Create; + {}) as Params$Resource$Namespaces$Cloudschedulersources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Domainmappings$Create; + params = {} as Params$Resource$Namespaces$Cloudschedulersources$Create; options = {}; } @@ -3381,7 +3432,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/domains.cloudrun.com/v1alpha1/{+parent}/domainmappings' + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudschedulersources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -3393,56 +3444,55 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.domainmappings.delete - * @desc Rpc to delete a domain mapping. - * @alias run.namespaces.domainmappings.delete + * run.namespaces.cloudschedulersources.delete + * @desc Rpc to delete a cloudschedulersource. + * @alias run.namespaces.cloudschedulersources.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string} params.name Required. The name of the cloudschedulersource being deleted. If needed, replace {namespace_id} with the project ID. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [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$Namespaces$Domainmappings$Delete, + params?: Params$Resource$Namespaces$Cloudschedulersources$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Namespaces$Domainmappings$Delete, + params: Params$Resource$Namespaces$Cloudschedulersources$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Namespaces$Domainmappings$Delete, + params: Params$Resource$Namespaces$Cloudschedulersources$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Namespaces$Domainmappings$Delete + | Params$Resource$Namespaces$Cloudschedulersources$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Domainmappings$Delete; + {}) as Params$Resource$Namespaces$Cloudschedulersources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Domainmappings$Delete; + params = {} as Params$Resource$Namespaces$Cloudschedulersources$Delete; options = {}; } @@ -3456,7 +3506,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/domains.cloudrun.com/v1alpha1/{+name}' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', }, @@ -3475,47 +3525,49 @@ export namespace run_v1alpha1 { } /** - * run.namespaces.domainmappings.get - * @desc Rpc to get information about a domain mapping. - * @alias run.namespaces.domainmappings.get + * run.namespaces.cloudschedulersources.get + * @desc Rpc to get information about a cloudschedulersource. + * @alias run.namespaces.cloudschedulersources.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name Required. The name of the cloudschedulersource being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Namespaces$Domainmappings$Get, + params?: Params$Resource$Namespaces$Cloudschedulersources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Domainmappings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudschedulersources$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Domainmappings$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudschedulersources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Domainmappings$Get - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudschedulersources$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Domainmappings$Get; + {}) as Params$Resource$Namespaces$Cloudschedulersources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Domainmappings$Get; + params = {} as Params$Resource$Namespaces$Cloudschedulersources$Get; options = {}; } @@ -3529,7 +3581,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/domains.cloudrun.com/v1alpha1/{+name}' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3541,16 +3593,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.domainmappings.list - * @desc Rpc to list domain mappings. - * @alias run.namespaces.domainmappings.list + * run.namespaces.cloudschedulersources.list + * @desc Rpc to list cloudschedulersources. + * @alias run.namespaces.cloudschedulersources.list * @memberOf! () * * @param {object} params Parameters for request @@ -3559,7 +3611,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. + * @param {string} params.parent Required. The project ID or project number from which the cloudschedulersources should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -3567,39 +3619,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Domainmappings$List, + params?: Params$Resource$Namespaces$Cloudschedulersources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Domainmappings$List, + params: Params$Resource$Namespaces$Cloudschedulersources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Domainmappings$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudschedulersources$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Domainmappings$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudschedulersources$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Domainmappings$List; + {}) as Params$Resource$Namespaces$Cloudschedulersources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Domainmappings$List; + params = {} as Params$Resource$Namespaces$Cloudschedulersources$List; options = {}; } @@ -3614,7 +3666,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/domains.cloudrun.com/v1alpha1/{+parent}/domainmappings' + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudschedulersources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -3626,17 +3678,97 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); + } + } + + /** + * run.namespaces.cloudschedulersources.replaceCloudSchedulerSource + * @desc Rpc to replace a cloudschedulersource. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.cloudschedulersources.replaceCloudSchedulerSource + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the cloudschedulersource being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().CloudSchedulerSource} params.requestBody Request 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 + */ + replaceCloudSchedulerSource( + params?: Params$Resource$Namespaces$Cloudschedulersources$Replacecloudschedulersource, + options?: MethodOptions + ): GaxiosPromise; + replaceCloudSchedulerSource( + params: Params$Resource$Namespaces$Cloudschedulersources$Replacecloudschedulersource, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceCloudSchedulerSource( + params: Params$Resource$Namespaces$Cloudschedulersources$Replacecloudschedulersource, + callback: BodyResponseCallback + ): void; + replaceCloudSchedulerSource( + callback: BodyResponseCallback + ): void; + replaceCloudSchedulerSource( + paramsOrCallback?: + | Params$Resource$Namespaces$Cloudschedulersources$Replacecloudschedulersource + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Cloudschedulersources$Replacecloudschedulersource; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Cloudschedulersources$Replacecloudschedulersource; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Domainmappings$Create + export interface Params$Resource$Namespaces$Cloudschedulersources$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -3644,16 +3776,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this domain mapping should be created. + * Required. The project ID or project number in which this cloudschedulersource should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$DomainMapping; + requestBody?: Schema$CloudSchedulerSource; } - export interface Params$Resource$Namespaces$Domainmappings$Delete + export interface Params$Resource$Namespaces$Cloudschedulersources$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -3669,19 +3801,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * Required. The name of the cloudschedulersource being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Namespaces$Domainmappings$Get + export interface Params$Resource$Namespaces$Cloudschedulersources$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -3689,11 +3817,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * Required. The name of the cloudschedulersource being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Domainmappings$List + export interface Params$Resource$Namespaces$Cloudschedulersources$List extends StandardParameters { /** * Auth client or API Key for the request @@ -3721,7 +3849,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the domain mappings should be listed. + * Required. The project ID or project number from which the cloudschedulersources should be listed. */ parent?: string; /** @@ -3733,55 +3861,73 @@ export namespace run_v1alpha1 { */ watch?: boolean; } + export interface Params$Resource$Namespaces$Cloudschedulersources$Replacecloudschedulersource + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the cloudschedulersource being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudSchedulerSource; + } - export class Resource$Namespaces$Eventtypes { + export class Resource$Namespaces$Cloudstoragesources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.eventtypes.get - * @desc Rpc to get information about an EventType. - * @alias run.namespaces.eventtypes.get + * run.namespaces.cloudstoragesources.create + * @desc Creates a new cloudstoragesource. + * @alias run.namespaces.cloudstoragesources.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.parent Required. The project ID or project number in which this cloudstoragesource should be created. + * @param {().CloudStorageSource} params.requestBody Request 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$Namespaces$Eventtypes$Get, + create( + params?: Params$Resource$Namespaces$Cloudstoragesources$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Eventtypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Cloudstoragesources$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Namespaces$Eventtypes$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Namespaces$Cloudstoragesources$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Namespaces$Eventtypes$Get - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudstoragesources$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Eventtypes$Get; + {}) as Params$Resource$Namespaces$Cloudstoragesources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Eventtypes$Get; + params = {} as Params$Resource$Namespaces$Cloudstoragesources$Create; options = {}; } @@ -3795,75 +3941,68 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' + rootUrl + + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudstoragesources' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.eventtypes.list - * @desc Rpc to list EventTypes. - * @alias run.namespaces.eventtypes.list + * run.namespaces.cloudstoragesources.delete + * @desc Rpc to delete a cloudstoragesource. + * @alias run.namespaces.cloudstoragesources.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the EventTypes should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name Required. The name of the cloudstoragesource being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Namespaces$Eventtypes$List, + delete( + params?: Params$Resource$Namespaces$Cloudstoragesources$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Namespaces$Eventtypes$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Cloudstoragesources$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Namespaces$Eventtypes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Namespaces$Cloudstoragesources$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Namespaces$Eventtypes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Cloudstoragesources$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Eventtypes$List; + {}) as Params$Resource$Namespaces$Cloudstoragesources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Eventtypes$List; + params = {} as Params$Resource$Namespaces$Cloudstoragesources$Delete; options = {}; } @@ -3877,217 +4016,9 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + - '/apis/eventing.knative.dev/v1alpha1/{+parent}/eventtypes' + rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - } - - export interface Params$Resource$Namespaces$Eventtypes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - } - export interface Params$Resource$Namespaces$Eventtypes$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional encoded string to continue paging. - */ - continue?: string; - /** - * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - */ - fieldSelector?: string; - /** - * Not currently used by Cloud Run. - */ - includeUninitialized?: boolean; - /** - * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - */ - labelSelector?: string; - /** - * The maximum number of records that should be returned. - */ - limit?: number; - /** - * The project ID or project number from which the EventTypes should be listed. - */ - parent?: string; - /** - * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - */ - resourceVersion?: string; - /** - * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - */ - watch?: boolean; - } - - export class Resource$Namespaces$Pubsubs { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * run.namespaces.pubsubs.create - * @desc Creates a new pubsub. - * @alias run.namespaces.pubsubs.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this pubsub should be created. - * @param {().PubSub} params.requestBody Request 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$Namespaces$Pubsubs$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Namespaces$Pubsubs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Namespaces$Pubsubs$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/apis/events.cloud.google.com/v1alpha1/{+parent}/pubsubs' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.pubsubs.delete - * @desc Rpc to delete a pubsub. - * @alias run.namespaces.pubsubs.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - * @param {object} [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$Namespaces$Pubsubs$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Namespaces$Pubsubs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Namespaces$Pubsubs$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'DELETE', }, options ), @@ -4104,45 +4035,47 @@ export namespace run_v1alpha1 { } /** - * run.namespaces.pubsubs.get - * @desc Rpc to get information about a pubsub. - * @alias run.namespaces.pubsubs.get + * run.namespaces.cloudstoragesources.get + * @desc Rpc to get information about a cloudstoragesource. + * @alias run.namespaces.cloudstoragesources.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name Required. The name of the cloudstoragesource being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Namespaces$Pubsubs$Get, + params?: Params$Resource$Namespaces$Cloudstoragesources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Pubsubs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudstoragesources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Pubsubs$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudstoragesources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Cloudstoragesources$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$Get; + {}) as Params$Resource$Namespaces$Cloudstoragesources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$Get; + params = {} as Params$Resource$Namespaces$Cloudstoragesources$Get; options = {}; } @@ -4168,16 +4101,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.pubsubs.list - * @desc Rpc to list pubsubs. - * @alias run.namespaces.pubsubs.list + * run.namespaces.cloudstoragesources.list + * @desc Rpc to list cloudstoragesources. + * @alias run.namespaces.cloudstoragesources.list * @memberOf! () * * @param {object} params Parameters for request @@ -4186,7 +4119,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the pubsubs should be listed. + * @param {string} params.parent Required. The project ID or project number from which the cloudstoragesources should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4194,35 +4127,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Pubsubs$List, + params?: Params$Resource$Namespaces$Cloudstoragesources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Cloudstoragesources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; list( - params: Params$Resource$Namespaces$Pubsubs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Cloudstoragesources$List, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Pubsubs$List, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Cloudstoragesources$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$List; + {}) as Params$Resource$Namespaces$Cloudstoragesources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$List; + params = {} as Params$Resource$Namespaces$Cloudstoragesources$List; options = {}; } @@ -4237,7 +4174,7 @@ export namespace run_v1alpha1 { { url: ( rootUrl + - '/apis/events.cloud.google.com/v1alpha1/{+parent}/pubsubs' + '/apis/events.cloud.google.com/v1alpha1/{+parent}/cloudstoragesources' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -4249,53 +4186,62 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * run.namespaces.pubsubs.replacePubSub - * @desc Rpc to replace a pubsub. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.namespaces.pubsubs.replacePubSub + * run.namespaces.cloudstoragesources.replaceCloudStorageSource + * @desc Rpc to replace a cloudstoragesource. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.cloudstoragesources.replaceCloudStorageSource * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().PubSub} params.requestBody Request body data + * @param {string} params.name Required. The name of the cloudstoragesource being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().CloudStorageSource} params.requestBody Request 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 */ - replacePubSub( - params?: Params$Resource$Namespaces$Pubsubs$Replacepubsub, + replaceCloudStorageSource( + params?: Params$Resource$Namespaces$Cloudstoragesources$Replacecloudstoragesource, options?: MethodOptions - ): GaxiosPromise; - replacePubSub( - params: Params$Resource$Namespaces$Pubsubs$Replacepubsub, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replacePubSub( - params: Params$Resource$Namespaces$Pubsubs$Replacepubsub, - callback: BodyResponseCallback - ): void; - replacePubSub(callback: BodyResponseCallback): void; - replacePubSub( + ): GaxiosPromise; + replaceCloudStorageSource( + params: Params$Resource$Namespaces$Cloudstoragesources$Replacecloudstoragesource, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceCloudStorageSource( + params: Params$Resource$Namespaces$Cloudstoragesources$Replacecloudstoragesource, + callback: BodyResponseCallback + ): void; + replaceCloudStorageSource( + callback: BodyResponseCallback + ): void; + replaceCloudStorageSource( paramsOrCallback?: - | Params$Resource$Namespaces$Pubsubs$Replacepubsub - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Cloudstoragesources$Replacecloudstoragesource + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Pubsubs$Replacepubsub; + {}) as Params$Resource$Namespaces$Cloudstoragesources$Replacecloudstoragesource; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Pubsubs$Replacepubsub; + params = {} as Params$Resource$Namespaces$Cloudstoragesources$Replacecloudstoragesource; options = {}; } @@ -4321,14 +4267,14 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Pubsubs$Create + export interface Params$Resource$Namespaces$Cloudstoragesources$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -4336,16 +4282,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this pubsub should be created. + * Required. The project ID or project number in which this cloudstoragesource should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$PubSub; + requestBody?: Schema$CloudStorageSource; } - export interface Params$Resource$Namespaces$Pubsubs$Delete + export interface Params$Resource$Namespaces$Cloudstoragesources$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -4361,7 +4307,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + * Required. The name of the cloudstoragesource being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** @@ -4369,7 +4315,7 @@ export namespace run_v1alpha1 { */ propagationPolicy?: string; } - export interface Params$Resource$Namespaces$Pubsubs$Get + export interface Params$Resource$Namespaces$Cloudstoragesources$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -4377,11 +4323,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * Required. The name of the cloudstoragesource being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Pubsubs$List + export interface Params$Resource$Namespaces$Cloudstoragesources$List extends StandardParameters { /** * Auth client or API Key for the request @@ -4409,7 +4355,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the pubsubs should be listed. + * Required. The project ID or project number from which the cloudstoragesources should be listed. */ parent?: string; /** @@ -4421,7 +4367,7 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Namespaces$Pubsubs$Replacepubsub + export interface Params$Resource$Namespaces$Cloudstoragesources$Replacecloudstoragesource extends StandardParameters { /** * Auth client or API Key for the request @@ -4429,66 +4375,64 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * Required. The name of the cloudstoragesource being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$PubSub; + requestBody?: Schema$CloudStorageSource; } - export class Resource$Namespaces$Revisions { + export class Resource$Namespaces$Configurations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.revisions.delete - * @desc Rpc to delete a revision. - * @alias run.namespaces.revisions.delete + * run.namespaces.configurations.get + * @desc Rpc to get information about a configuration. + * @alias run.namespaces.configurations.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Namespaces$Revisions$Delete, + get( + params?: Params$Resource$Namespaces$Configurations$Get, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Namespaces$Revisions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Configurations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Namespaces$Revisions$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Namespaces$Configurations$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Configurations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Revisions$Delete; + {}) as Params$Resource$Namespaces$Configurations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$Delete; + params = {} as Params$Resource$Namespaces$Configurations$Get; options = {}; } @@ -4504,7 +4448,7 @@ export namespace run_v1alpha1 { url: ( rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), @@ -4514,87 +4458,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.revisions.get - * @desc Rpc to get information about a revision. - * @alias run.namespaces.revisions.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Namespaces$Revisions$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Revisions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Namespaces$Revisions$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Revisions$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.namespaces.revisions.list - * @desc Rpc to list revisions. - * @alias run.namespaces.revisions.list + * run.namespaces.configurations.list + * @desc Rpc to list configurations. + * @alias run.namespaces.configurations.list * @memberOf! () * * @param {object} params Parameters for request @@ -4603,7 +4476,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the revisions should be listed. + * @param {string} params.parent The project ID or project number from which the configurations should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4611,37 +4484,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Revisions$List, + params?: Params$Resource$Namespaces$Configurations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Revisions$List, + params: Params$Resource$Namespaces$Configurations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Revisions$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Configurations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Revisions$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Configurations$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Revisions$List; + {}) as Params$Resource$Namespaces$Configurations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Revisions$List; + params = {} as Params$Resource$Namespaces$Configurations$List; options = {}; } @@ -4655,7 +4530,8 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/revisions' + rootUrl + + '/apis/serving.knative.dev/v1alpha1/{+parent}/configurations' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -4667,42 +4543,17 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Revisions$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Cloud Run currently ignores this parameter. - */ - apiVersion?: string; - /** - * Cloud Run currently ignores this parameter. - */ - kind?: string; - /** - * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; - /** - * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - */ - propagationPolicy?: string; - } - export interface Params$Resource$Namespaces$Revisions$Get + export interface Params$Resource$Namespaces$Configurations$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -4710,11 +4561,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Revisions$List + export interface Params$Resource$Namespaces$Configurations$List extends StandardParameters { /** * Auth client or API Key for the request @@ -4742,7 +4593,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the revisions should be listed. + * The project ID or project number from which the configurations should be listed. */ parent?: string; /** @@ -4755,52 +4606,55 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Namespaces$Routes { + export class Resource$Namespaces$Domainmappings { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.routes.get - * @desc Rpc to get information about a route. - * @alias run.namespaces.routes.get + * run.namespaces.domainmappings.create + * @desc Creates a new domain mapping. + * @alias run.namespaces.domainmappings.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.parent The project ID or project number in which this domain mapping should be created. + * @param {().DomainMapping} params.requestBody Request 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$Namespaces$Routes$Get, + create( + params?: Params$Resource$Namespaces$Domainmappings$Create, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Routes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + create( + params: Params$Resource$Namespaces$Domainmappings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Namespaces$Routes$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Namespaces$Domainmappings$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Namespaces$Routes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Domainmappings$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Routes$Get; + {}) as Params$Resource$Namespaces$Domainmappings$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Routes$Get; + params = {} as Params$Resource$Namespaces$Domainmappings$Create; options = {}; } @@ -4814,73 +4668,69 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + + '/apis/domains.cloudrun.com/v1alpha1/{+parent}/domainmappings' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.routes.list - * @desc Rpc to list routes. - * @alias run.namespaces.routes.list + * run.namespaces.domainmappings.delete + * @desc Rpc to delete a domain mapping. + * @alias run.namespaces.domainmappings.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the routes should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Namespaces$Routes$List, + delete( + params?: Params$Resource$Namespaces$Domainmappings$Delete, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Namespaces$Routes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Domainmappings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Namespaces$Routes$List, - callback: BodyResponseCallback + delete( + params: Params$Resource$Namespaces$Domainmappings$Delete, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Namespaces$Routes$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Domainmappings$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Routes$List; + {}) as Params$Resource$Namespaces$Domainmappings$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Routes$List; + params = {} as Params$Resource$Namespaces$Domainmappings$Delete; options = {}; } @@ -4894,125 +4744,66 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/routes' + rootUrl + '/apis/domains.cloudrun.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Namespaces$Routes$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - } - export interface Params$Resource$Namespaces$Routes$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional encoded string to continue paging. - */ - continue?: string; - /** - * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - */ - fieldSelector?: string; - /** - * Not currently used by Cloud Run. - */ - includeUninitialized?: boolean; - /** - * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - */ - labelSelector?: string; - /** - * The maximum number of records that should be returned. - */ - limit?: number; - /** - * The project ID or project number from which the routes should be listed. - */ - parent?: string; - /** - * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - */ - resourceVersion?: string; - /** - * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - */ - watch?: boolean; - } - - export class Resource$Namespaces$Services { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * run.namespaces.services.create - * @desc Rpc to create a service. - * @alias run.namespaces.services.create + * run.namespaces.domainmappings.get + * @desc Rpc to get information about a domain mapping. + * @alias run.namespaces.domainmappings.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this service should be created. - * @param {().Service} params.requestBody Request body data + * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - create( - params?: Params$Resource$Namespaces$Services$Create, + get( + params?: Params$Resource$Namespaces$Domainmappings$Get, options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Namespaces$Services$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Namespaces$Services$Create, - callback: BodyResponseCallback + get( + params: Params$Resource$Namespaces$Domainmappings$Get, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Namespaces$Services$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Domainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$Create; + {}) as Params$Resource$Namespaces$Domainmappings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$Create; + params = {} as Params$Resource$Namespaces$Domainmappings$Get; options = {}; } @@ -5026,68 +4817,77 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/services' + rootUrl + '/apis/domains.cloudrun.com/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.services.delete - * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. - * @alias run.namespaces.services.delete + * run.namespaces.domainmappings.list + * @desc Rpc to list domain mappings. + * @alias run.namespaces.domainmappings.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the service being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Namespaces$Services$Delete, + list( + params?: Params$Resource$Namespaces$Domainmappings$List, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Namespaces$Services$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Domainmappings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Namespaces$Services$Delete, - callback: BodyResponseCallback + list( + params: Params$Resource$Namespaces$Domainmappings$List, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Namespaces$Services$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Domainmappings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$Delete; + {}) as Params$Resource$Namespaces$Domainmappings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$Delete; + params = {} as Params$Resource$Namespaces$Domainmappings$List; options = {}; } @@ -5101,64 +4901,248 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + + '/apis/domains.cloudrun.com/v1alpha1/{+parent}/domainmappings' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Namespaces$Domainmappings$Create + extends StandardParameters { /** - * run.namespaces.services.get - * @desc Rpc to get information about a service. - * @alias run.namespaces.services.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object + * Auth client or API Key for the request */ - get( - params?: Params$Resource$Namespaces$Services$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Namespaces$Services$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Namespaces$Services$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Namespaces$Services$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The project ID or project number in which this domain mapping should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DomainMapping; + } + export interface Params$Resource$Namespaces$Domainmappings$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Namespaces$Domainmappings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Namespaces$Domainmappings$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the domain mappings should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Namespaces$Revisions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.revisions.delete + * @desc Rpc to delete a revision. + * @alias run.namespaces.revisions.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [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$Namespaces$Revisions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Namespaces$Revisions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Namespaces$Revisions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Namespaces$Revisions$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$Get; + {}) as Params$Resource$Namespaces$Revisions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$Get; + params = {} as Params$Resource$Namespaces$Revisions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.revisions.get + * @desc Rpc to get information about a revision. + * @alias run.namespaces.revisions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Namespaces$Revisions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Revisions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Revisions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Namespaces$Revisions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Revisions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Revisions$Get; options = {}; } @@ -5184,16 +5168,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.services.list - * @desc Rpc to list services. - * @alias run.namespaces.services.list + * run.namespaces.revisions.list + * @desc Rpc to list revisions. + * @alias run.namespaces.revisions.list * @memberOf! () * * @param {object} params Parameters for request @@ -5202,7 +5186,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the services should be listed. + * @param {string} params.parent The project ID or project number from which the revisions should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5210,37 +5194,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Services$List, + params?: Params$Resource$Namespaces$Revisions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Services$List, + params: Params$Resource$Namespaces$Revisions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Services$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Revisions$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Services$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Revisions$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$List; + {}) as Params$Resource$Namespaces$Revisions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$List; + params = {} as Params$Resource$Namespaces$Revisions$List; options = {}; } @@ -5254,7 +5238,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/services' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/revisions' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -5266,53 +5250,220 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Namespaces$Revisions$Delete + extends StandardParameters { /** - * run.namespaces.services.replaceService - * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.namespaces.services.replaceService + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Namespaces$Revisions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Namespaces$Revisions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the revisions should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Namespaces$Routes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * run.namespaces.routes.get + * @desc Rpc to get information about a route. + * @alias run.namespaces.routes.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. - * @param {().Service} params.requestBody Request body data + * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Namespaces$Routes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Namespaces$Routes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Namespaces$Routes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Namespaces$Routes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Namespaces$Routes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Namespaces$Routes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.namespaces.routes.list + * @desc Rpc to list routes. + * @alias run.namespaces.routes.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the routes should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - replaceService( - params?: Params$Resource$Namespaces$Services$Replaceservice, + list( + params?: Params$Resource$Namespaces$Routes$List, options?: MethodOptions - ): GaxiosPromise; - replaceService( - params: Params$Resource$Namespaces$Services$Replaceservice, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Namespaces$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - replaceService( - params: Params$Resource$Namespaces$Services$Replaceservice, - callback: BodyResponseCallback + list( + params: Params$Resource$Namespaces$Routes$List, + callback: BodyResponseCallback ): void; - replaceService(callback: BodyResponseCallback): void; - replaceService( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Namespaces$Services$Replaceservice - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Routes$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Services$Replaceservice; + {}) as Params$Resource$Namespaces$Routes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Services$Replaceservice; + params = {} as Params$Resource$Namespaces$Routes$List; options = {}; } @@ -5326,71 +5477,26 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/routes' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Services$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The project ID or project number in which this service should be created. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Service; - } - export interface Params$Resource$Namespaces$Services$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Cloud Run currently ignores this parameter. - */ - apiVersion?: string; - /** - * Cloud Run currently ignores this parameter. - */ - kind?: string; - /** - * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; - /** - * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - */ - propagationPolicy?: string; - } - export interface Params$Resource$Namespaces$Services$Get + export interface Params$Resource$Namespaces$Routes$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -5398,11 +5504,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Services$List + export interface Params$Resource$Namespaces$Routes$List extends StandardParameters { /** * Auth client or API Key for the request @@ -5430,7 +5536,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the services should be listed. + * The project ID or project number from which the routes should be listed. */ parent?: string; /** @@ -5442,71 +5548,54 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Namespaces$Services$Replaceservice - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Service; - } - export class Resource$Namespaces$Storages { + export class Resource$Namespaces$Services { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.namespaces.storages.create - * @desc Creates a new storage. - * @alias run.namespaces.storages.create + * run.namespaces.services.create + * @desc Rpc to create a service. + * @alias run.namespaces.services.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this storage should be created. - * @param {().Storage} params.requestBody Request body data + * @param {string} params.parent The project ID or project number in which this service should be created. + * @param {().Service} params.requestBody Request 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$Namespaces$Storages$Create, + params?: Params$Resource$Namespaces$Services$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Namespaces$Storages$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Namespaces$Storages$Create, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Namespaces$Storages$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Services$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Storages$Create; + {}) as Params$Resource$Namespaces$Services$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Storages$Create; + params = {} as Params$Resource$Namespaces$Services$Create; options = {}; } @@ -5520,8 +5609,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + - '/apis/events.cloud.google.com/v1alpha1/{+parent}/storages' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/services' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -5533,55 +5621,56 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.storages.delete - * @desc Rpc to delete a storage. - * @alias run.namespaces.storages.delete + * run.namespaces.services.delete + * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. + * @alias run.namespaces.services.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the storage being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the service being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [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$Namespaces$Storages$Delete, + params?: Params$Resource$Namespaces$Services$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Namespaces$Storages$Delete, + params: Params$Resource$Namespaces$Services$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Namespaces$Storages$Delete, + params: Params$Resource$Namespaces$Services$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Namespaces$Storages$Delete + | Params$Resource$Namespaces$Services$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Storages$Delete; + {}) as Params$Resource$Namespaces$Services$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Storages$Delete; + params = {} as Params$Resource$Namespaces$Services$Delete; options = {}; } @@ -5595,7 +5684,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', }, @@ -5614,45 +5703,45 @@ export namespace run_v1alpha1 { } /** - * run.namespaces.storages.get - * @desc Rpc to get information about a storage. - * @alias run.namespaces.storages.get + * run.namespaces.services.get + * @desc Rpc to get information about a service. + * @alias run.namespaces.services.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Namespaces$Storages$Get, + params?: Params$Resource$Namespaces$Services$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Namespaces$Storages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Namespaces$Storages$Get, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Namespaces$Storages$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Services$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Storages$Get; + {}) as Params$Resource$Namespaces$Services$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Storages$Get; + params = {} as Params$Resource$Namespaces$Services$Get; options = {}; } @@ -5666,7 +5755,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -5678,16 +5767,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.storages.list - * @desc Rpc to list storages. - * @alias run.namespaces.storages.list + * run.namespaces.services.list + * @desc Rpc to list services. + * @alias run.namespaces.services.list * @memberOf! () * * @param {object} params Parameters for request @@ -5696,7 +5785,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the storages should be listed. + * @param {string} params.parent The project ID or project number from which the services should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -5704,37 +5793,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Namespaces$Storages$List, + params?: Params$Resource$Namespaces$Services$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Namespaces$Storages$List, + params: Params$Resource$Namespaces$Services$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Namespaces$Storages$List, - callback: BodyResponseCallback + params: Params$Resource$Namespaces$Services$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Namespaces$Storages$List - | BodyResponseCallback, + | Params$Resource$Namespaces$Services$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Storages$List; + {}) as Params$Resource$Namespaces$Services$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Storages$List; + params = {} as Params$Resource$Namespaces$Services$List; options = {}; } @@ -5748,8 +5837,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + - '/apis/events.cloud.google.com/v1alpha1/{+parent}/storages' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+parent}/services' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, @@ -5761,53 +5849,53 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.namespaces.storages.replaceStorage - * @desc Rpc to replace a storage. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.namespaces.storages.replaceStorage + * run.namespaces.services.replaceService + * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.namespaces.services.replaceService * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().Storage} params.requestBody Request body data + * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + * @param {().Service} params.requestBody Request 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 */ - replaceStorage( - params?: Params$Resource$Namespaces$Storages$Replacestorage, + replaceService( + params?: Params$Resource$Namespaces$Services$Replaceservice, options?: MethodOptions - ): GaxiosPromise; - replaceStorage( - params: Params$Resource$Namespaces$Storages$Replacestorage, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceStorage( - params: Params$Resource$Namespaces$Storages$Replacestorage, - callback: BodyResponseCallback - ): void; - replaceStorage(callback: BodyResponseCallback): void; - replaceStorage( + ): GaxiosPromise; + replaceService( + params: Params$Resource$Namespaces$Services$Replaceservice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceService( + params: Params$Resource$Namespaces$Services$Replaceservice, + callback: BodyResponseCallback + ): void; + replaceService(callback: BodyResponseCallback): void; + replaceService( paramsOrCallback?: - | Params$Resource$Namespaces$Storages$Replacestorage - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Namespaces$Services$Replaceservice + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Storages$Replacestorage; + {}) as Params$Resource$Namespaces$Services$Replaceservice; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Storages$Replacestorage; + params = {} as Params$Resource$Namespaces$Services$Replaceservice; options = {}; } @@ -5821,7 +5909,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: ( - rootUrl + '/apis/events.cloud.google.com/v1alpha1/{+name}' + rootUrl + '/apis/serving.knative.dev/v1alpha1/{+name}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'PUT', }, @@ -5833,14 +5921,14 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Namespaces$Storages$Create + export interface Params$Resource$Namespaces$Services$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -5848,16 +5936,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this storage should be created. + * The project ID or project number in which this service should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$Storage; + requestBody?: Schema$Service; } - export interface Params$Resource$Namespaces$Storages$Delete + export interface Params$Resource$Namespaces$Services$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -5873,15 +5961,19 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the storage being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Namespaces$Storages$Get + export interface Params$Resource$Namespaces$Services$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -5889,11 +5981,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Namespaces$Storages$List + export interface Params$Resource$Namespaces$Services$List extends StandardParameters { /** * Auth client or API Key for the request @@ -5921,7 +6013,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the storages should be listed. + * The project ID or project number from which the services should be listed. */ parent?: string; /** @@ -5933,7 +6025,7 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Namespaces$Storages$Replacestorage + export interface Params$Resource$Namespaces$Services$Replaceservice extends StandardParameters { /** * Auth client or API Key for the request @@ -5941,14 +6033,14 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$Storage; + requestBody?: Schema$Service; } export class Resource$Namespaces$Triggers { @@ -6181,7 +6273,7 @@ export namespace run_v1alpha1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.continue Optional. Encoded string to continue paging. * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. @@ -6255,78 +6347,6 @@ export namespace run_v1alpha1 { return createAPIRequest(parameters); } } - - /** - * run.namespaces.triggers.replaceTrigger - * @desc Rpc to replace a trigger. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.namespaces.triggers.replaceTrigger - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().Trigger} params.requestBody Request 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 - */ - replaceTrigger( - params?: Params$Resource$Namespaces$Triggers$Replacetrigger, - options?: MethodOptions - ): GaxiosPromise; - replaceTrigger( - params: Params$Resource$Namespaces$Triggers$Replacetrigger, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceTrigger( - params: Params$Resource$Namespaces$Triggers$Replacetrigger, - callback: BodyResponseCallback - ): void; - replaceTrigger(callback: BodyResponseCallback): void; - replaceTrigger( - paramsOrCallback?: - | Params$Resource$Namespaces$Triggers$Replacetrigger - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Namespaces$Triggers$Replacetrigger; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Namespaces$Triggers$Replacetrigger; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/apis/eventing.knative.dev/v1alpha1/{+name}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Namespaces$Triggers$Create @@ -6390,7 +6410,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional encoded string to continue paging. + * Optional. Encoded string to continue paging. */ continue?: string; /** @@ -6422,23 +6442,6 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Namespaces$Triggers$Replacetrigger - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Trigger; - } export class Resource$Projects { context: APIRequestContext; @@ -6452,38 +6455,42 @@ export namespace run_v1alpha1 { export class Resource$Projects$Locations { context: APIRequestContext; authorizeddomains: Resource$Projects$Locations$Authorizeddomains; - cloudauditlogs: Resource$Projects$Locations$Cloudauditlogs; + cloudauditlogssources: Resource$Projects$Locations$Cloudauditlogssources; + cloudpubsubsources: Resource$Projects$Locations$Cloudpubsubsources; + cloudschedulersources: Resource$Projects$Locations$Cloudschedulersources; + cloudstoragesources: Resource$Projects$Locations$Cloudstoragesources; configurations: Resource$Projects$Locations$Configurations; domainmappings: Resource$Projects$Locations$Domainmappings; - eventtypes: Resource$Projects$Locations$Eventtypes; - pubsubs: Resource$Projects$Locations$Pubsubs; revisions: Resource$Projects$Locations$Revisions; routes: Resource$Projects$Locations$Routes; services: Resource$Projects$Locations$Services; - storages: Resource$Projects$Locations$Storages; triggers: Resource$Projects$Locations$Triggers; constructor(context: APIRequestContext) { this.context = context; this.authorizeddomains = new Resource$Projects$Locations$Authorizeddomains( this.context ); - this.cloudauditlogs = new Resource$Projects$Locations$Cloudauditlogs( + this.cloudauditlogssources = new Resource$Projects$Locations$Cloudauditlogssources( this.context ); - this.configurations = new Resource$Projects$Locations$Configurations( + this.cloudpubsubsources = new Resource$Projects$Locations$Cloudpubsubsources( this.context ); - this.domainmappings = new Resource$Projects$Locations$Domainmappings( + this.cloudschedulersources = new Resource$Projects$Locations$Cloudschedulersources( + this.context + ); + this.cloudstoragesources = new Resource$Projects$Locations$Cloudstoragesources( this.context ); - this.eventtypes = new Resource$Projects$Locations$Eventtypes( + this.configurations = new Resource$Projects$Locations$Configurations( + this.context + ); + this.domainmappings = new Resource$Projects$Locations$Domainmappings( this.context ); - this.pubsubs = new Resource$Projects$Locations$Pubsubs(this.context); this.revisions = new Resource$Projects$Locations$Revisions(this.context); this.routes = new Resource$Projects$Locations$Routes(this.context); this.services = new Resource$Projects$Locations$Services(this.context); - this.storages = new Resource$Projects$Locations$Storages(this.context); this.triggers = new Resource$Projects$Locations$Triggers(this.context); } @@ -6705,283 +6712,57 @@ export namespace run_v1alpha1 { parent?: string; } - export class Resource$Projects$Locations$Cloudauditlogs { + export class Resource$Projects$Locations$Cloudauditlogssources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.cloudauditlogs.create - * @desc Creates a new cloudauditlog. - * @alias run.projects.locations.cloudauditlogs.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this cloudauditlog should be created. - * @param {().CloudAuditLog} params.requestBody Request 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$Cloudauditlogs$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Cloudauditlogs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Cloudauditlogs$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudauditlogs$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudauditlogs$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+parent}/cloudauditlogs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.cloudauditlogs.delete - * @desc Rpc to delete a cloudauditlog. - * @alias run.projects.locations.cloudauditlogs.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the cloudauditlog being deleted. If needed, replace {namespace_id} with the project ID. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - * @param {object} [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$Cloudauditlogs$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Cloudauditlogs$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Cloudauditlogs$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudauditlogs$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudauditlogs$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.cloudauditlogs.get - * @desc Rpc to get information about a cloudauditlog. - * @alias run.projects.locations.cloudauditlogs.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Cloudauditlogs$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Cloudauditlogs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Cloudauditlogs$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudauditlogs$Get - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudauditlogs$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.cloudauditlogs.list - * @desc Rpc to list cloudauditlogs. - * @alias run.projects.locations.cloudauditlogs.list + * run.projects.locations.cloudauditlogssources.create + * @desc Creates a new cloudauditlogssource. + * @alias run.projects.locations.cloudauditlogssources.create * @memberOf! () * - * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the cloudauditlogs should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} params Parameters for request + * @param {string} params.parent The project ID or project number in which this cloudauditlogssource should be created. + * @param {().CloudAuditLogsSource} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Cloudauditlogs$List, + create( + params?: Params$Resource$Projects$Locations$Cloudauditlogssources$Create, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Cloudauditlogs$List, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Cloudauditlogssources$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Projects$Locations$Cloudauditlogs$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Cloudauditlogssources$Create, + callback: BodyResponseCallback ): void; - list( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudauditlogs$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudauditlogssources$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudauditlogs$List; + {}) as Params$Resource$Projects$Locations$Cloudauditlogssources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$List; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogssources$Create; options = {}; } @@ -6994,11 +6775,10 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/cloudauditlogs').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + '/v1alpha1/{+parent}/cloudauditlogssources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', }, options ), @@ -7008,60 +6788,55 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.cloudauditlogs.replaceCloudAuditLog - * @desc Rpc to replace a cloudauditlog. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.projects.locations.cloudauditlogs.replaceCloudAuditLog + * run.projects.locations.cloudauditlogssources.delete + * @desc Rpc to delete a cloudauditlogssource. + * @alias run.projects.locations.cloudauditlogssources.delete * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().CloudAuditLog} params.requestBody Request body data + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the cloudauditlogssource being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - replaceCloudAuditLog( - params?: Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog, + delete( + params?: Params$Resource$Projects$Locations$Cloudauditlogssources$Delete, options?: MethodOptions - ): GaxiosPromise; - replaceCloudAuditLog( - params: Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceCloudAuditLog( - params: Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog, - callback: BodyResponseCallback + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Cloudauditlogssources$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - replaceCloudAuditLog( - callback: BodyResponseCallback + delete( + params: Params$Resource$Projects$Locations$Cloudauditlogssources$Delete, + callback: BodyResponseCallback ): void; - replaceCloudAuditLog( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Cloudauditlogssources$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog; + {}) as Params$Resource$Projects$Locations$Cloudauditlogssources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogssources$Delete; options = {}; } @@ -7075,7 +6850,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + method: 'DELETE', }, options ), @@ -7085,172 +6860,56 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } - } - - export interface Params$Resource$Projects$Locations$Cloudauditlogs$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The project ID or project number in which this cloudauditlog should be created. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CloudAuditLog; - } - export interface Params$Resource$Projects$Locations$Cloudauditlogs$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Cloud Run currently ignores this parameter. - */ - apiVersion?: string; - /** - * Cloud Run currently ignores this parameter. - */ - kind?: string; - /** - * The name of the cloudauditlog being deleted. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - /** - * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - */ - propagationPolicy?: string; - } - export interface Params$Resource$Projects$Locations$Cloudauditlogs$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Cloudauditlogs$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional encoded string to continue paging. - */ - continue?: string; - /** - * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - */ - fieldSelector?: string; - /** - * Not currently used by Cloud Run. - */ - includeUninitialized?: boolean; - /** - * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - */ - labelSelector?: string; - /** - * The maximum number of records that should be returned. - */ - limit?: number; - /** - * The project ID or project number from which the cloudauditlogs should be listed. - */ - parent?: string; - /** - * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - */ - resourceVersion?: string; - /** - * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. - */ - watch?: boolean; - } - export interface Params$Resource$Projects$Locations$Cloudauditlogs$Replacecloudauditlog - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the cloudauditlog being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$CloudAuditLog; - } - - export class Resource$Projects$Locations$Configurations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } /** - * run.projects.locations.configurations.get - * @desc Rpc to get information about a configuration. - * @alias run.projects.locations.configurations.get + * run.projects.locations.cloudauditlogssources.get + * @desc Rpc to get information about a cloudauditlogssource. + * @alias run.projects.locations.cloudauditlogssources.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the cloudauditlogssource being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Configurations$Get, + params?: Params$Resource$Projects$Locations$Cloudauditlogssources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Configurations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudauditlogssources$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Configurations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudauditlogssources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Configurations$Get - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudauditlogssources$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Configurations$Get; + {}) as Params$Resource$Projects$Locations$Cloudauditlogssources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Configurations$Get; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogssources$Get; options = {}; } @@ -7274,16 +6933,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.configurations.list - * @desc Rpc to list configurations. - * @alias run.projects.locations.configurations.list + * run.projects.locations.cloudauditlogssources.list + * @desc Rpc to list cloudauditlogssources. + * @alias run.projects.locations.cloudauditlogssources.list * @memberOf! () * * @param {object} params Parameters for request @@ -7292,7 +6951,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the configurations should be listed. + * @param {string} params.parent The project ID or project number from which the cloudauditlogssources should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7300,39 +6959,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Configurations$List, + params?: Params$Resource$Projects$Locations$Cloudauditlogssources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Configurations$List, + params: Params$Resource$Projects$Locations$Cloudauditlogssources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Configurations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudauditlogssources$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Configurations$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudauditlogssources$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Configurations$List; + {}) as Params$Resource$Projects$Locations$Cloudauditlogssources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Configurations$List; + params = {} as Params$Resource$Projects$Locations$Cloudauditlogssources$List; options = {}; } @@ -7345,10 +7004,9 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/configurations').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha1/{+parent}/cloudauditlogssources' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -7359,17 +7017,19 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Configurations$Get + export interface Params$Resource$Projects$Locations$Cloudauditlogssources$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -7377,11 +7037,52 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. + * The project ID or project number in which this cloudauditlogssource should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudAuditLogsSource; + } + export interface Params$Resource$Projects$Locations$Cloudauditlogssources$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the cloudauditlogssource being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Configurations$List + export interface Params$Resource$Projects$Locations$Cloudauditlogssources$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the cloudauditlogssource being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Cloudauditlogssources$List extends StandardParameters { /** * Auth client or API Key for the request @@ -7409,7 +7110,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the configurations should be listed. + * The project ID or project number from which the cloudauditlogssources should be listed. */ parent?: string; /** @@ -7422,55 +7123,55 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Projects$Locations$Domainmappings { + export class Resource$Projects$Locations$Cloudpubsubsources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.domainmappings.create - * @desc Creates a new domain mapping. - * @alias run.projects.locations.domainmappings.create + * run.projects.locations.cloudpubsubsources.create + * @desc Creates a new cloudpubsubsource. + * @alias run.projects.locations.cloudpubsubsources.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this domain mapping should be created. - * @param {().DomainMapping} params.requestBody Request body data + * @param {string} params.parent The project ID or project number in which this cloudpubsubsource should be created. + * @param {().CloudPubSubSource} params.requestBody Request 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$Domainmappings$Create, + params?: Params$Resource$Projects$Locations$Cloudpubsubsources$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Domainmappings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudpubsubsources$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Domainmappings$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudpubsubsources$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Create - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudpubsubsources$Create + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Create; + {}) as Params$Resource$Projects$Locations$Cloudpubsubsources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Create; + params = {} as Params$Resource$Projects$Locations$Cloudpubsubsources$Create; options = {}; } @@ -7483,7 +7184,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( + url: (rootUrl + '/v1alpha1/{+parent}/cloudpubsubsources').replace( /([^:]\/)\/+/g, '$1' ), @@ -7497,56 +7198,55 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.domainmappings.delete - * @desc Rpc to delete a domain mapping. - * @alias run.projects.locations.domainmappings.delete + * run.projects.locations.cloudpubsubsources.delete + * @desc Rpc to delete a cloudpubsubsource. + * @alias run.projects.locations.cloudpubsubsources.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string} params.name The name of the cloudpubsubsource being deleted. If needed, replace {namespace_id} with the project ID. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [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$Domainmappings$Delete, + params?: Params$Resource$Projects$Locations$Cloudpubsubsources$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Domainmappings$Delete, + params: Params$Resource$Projects$Locations$Cloudpubsubsources$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Domainmappings$Delete, + params: Params$Resource$Projects$Locations$Cloudpubsubsources$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Delete + | Params$Resource$Projects$Locations$Cloudpubsubsources$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Delete; + {}) as Params$Resource$Projects$Locations$Cloudpubsubsources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Delete; + params = {} as Params$Resource$Projects$Locations$Cloudpubsubsources$Delete; options = {}; } @@ -7577,47 +7277,47 @@ export namespace run_v1alpha1 { } /** - * run.projects.locations.domainmappings.get - * @desc Rpc to get information about a domain mapping. - * @alias run.projects.locations.domainmappings.get + * run.projects.locations.cloudpubsubsources.get + * @desc Rpc to get information about a cloudpubsubsource. + * @alias run.projects.locations.cloudpubsubsources.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the cloudpubsubsource being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Domainmappings$Get, + params?: Params$Resource$Projects$Locations$Cloudpubsubsources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Domainmappings$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudpubsubsources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Domainmappings$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudpubsubsources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$Get - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudpubsubsources$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$Get; + {}) as Params$Resource$Projects$Locations$Cloudpubsubsources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$Get; + params = {} as Params$Resource$Projects$Locations$Cloudpubsubsources$Get; options = {}; } @@ -7641,16 +7341,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.domainmappings.list - * @desc Rpc to list domain mappings. - * @alias run.projects.locations.domainmappings.list + * run.projects.locations.cloudpubsubsources.list + * @desc Rpc to list cloudpubsubsources. + * @alias run.projects.locations.cloudpubsubsources.list * @memberOf! () * * @param {object} params Parameters for request @@ -7659,7 +7359,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. + * @param {string} params.parent The project ID or project number from which the cloudpubsubsources should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7667,39 +7367,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Domainmappings$List, + params?: Params$Resource$Projects$Locations$Cloudpubsubsources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Domainmappings$List, + params: Params$Resource$Projects$Locations$Cloudpubsubsources$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Domainmappings$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudpubsubsources$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Domainmappings$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudpubsubsources$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Domainmappings$List; + {}) as Params$Resource$Projects$Locations$Cloudpubsubsources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Domainmappings$List; + params = {} as Params$Resource$Projects$Locations$Cloudpubsubsources$List; options = {}; } @@ -7712,7 +7412,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( + url: (rootUrl + '/v1alpha1/{+parent}/cloudpubsubsources').replace( /([^:]\/)\/+/g, '$1' ), @@ -7726,17 +7426,19 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } } - export interface Params$Resource$Projects$Locations$Domainmappings$Create + export interface Params$Resource$Projects$Locations$Cloudpubsubsources$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -7744,16 +7446,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this domain mapping should be created. + * The project ID or project number in which this cloudpubsubsource should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$DomainMapping; + requestBody?: Schema$CloudPubSubSource; } - export interface Params$Resource$Projects$Locations$Domainmappings$Delete + export interface Params$Resource$Projects$Locations$Cloudpubsubsources$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -7769,19 +7471,15 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the cloudpubsubsource being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Domainmappings$Get + export interface Params$Resource$Projects$Locations$Cloudpubsubsources$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -7789,11 +7487,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the cloudpubsubsource being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Domainmappings$List + export interface Params$Resource$Projects$Locations$Cloudpubsubsources$List extends StandardParameters { /** * Auth client or API Key for the request @@ -7821,7 +7519,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the domain mappings should be listed. + * The project ID or project number from which the cloudpubsubsources should be listed. */ parent?: string; /** @@ -7834,54 +7532,204 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Projects$Locations$Eventtypes { + export class Resource$Projects$Locations$Cloudschedulersources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.eventtypes.get - * @desc Rpc to get information about an EventType. - * @alias run.projects.locations.eventtypes.get + * run.projects.locations.cloudschedulersources.create + * @desc Creates a new cloudschedulersource. + * @alias run.projects.locations.cloudschedulersources.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.parent Required. The project ID or project number in which this cloudschedulersource should be created. + * @param {().CloudSchedulerSource} params.requestBody Request 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$Cloudschedulersources$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Cloudschedulersources$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Cloudschedulersources$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudschedulersources$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudschedulersources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudschedulersources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha1/{+parent}/cloudschedulersources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.cloudschedulersources.delete + * @desc Rpc to delete a cloudschedulersource. + * @alias run.projects.locations.cloudschedulersources.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name Required. The name of the cloudschedulersource being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [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$Cloudschedulersources$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Cloudschedulersources$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Cloudschedulersources$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudschedulersources$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudschedulersources$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudschedulersources$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.cloudschedulersources.get + * @desc Rpc to get information about a cloudschedulersource. + * @alias run.projects.locations.cloudschedulersources.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the cloudschedulersource being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Eventtypes$Get, + params?: Params$Resource$Projects$Locations$Cloudschedulersources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Eventtypes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudschedulersources$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Eventtypes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudschedulersources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Eventtypes$Get - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudschedulersources$Get + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Eventtypes$Get; + {}) as Params$Resource$Projects$Locations$Cloudschedulersources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Eventtypes$Get; + params = {} as Params$Resource$Projects$Locations$Cloudschedulersources$Get; options = {}; } @@ -7905,63 +7753,148 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.cloudschedulersources.list + * @desc Rpc to list cloudschedulersources. + * @alias run.projects.locations.cloudschedulersources.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent Required. The project ID or project number from which the cloudschedulersources should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Cloudschedulersources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cloudschedulersources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Cloudschedulersources$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Cloudschedulersources$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Cloudschedulersources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Cloudschedulersources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1alpha1/{+parent}/cloudschedulersources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * run.projects.locations.eventtypes.list - * @desc Rpc to list EventTypes. - * @alias run.projects.locations.eventtypes.list + * run.projects.locations.cloudschedulersources.replaceCloudSchedulerSource + * @desc Rpc to replace a cloudschedulersource. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.cloudschedulersources.replaceCloudSchedulerSource * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the EventTypes should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {string} params.name Required. The name of the cloudschedulersource being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().CloudSchedulerSource} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Eventtypes$List, + replaceCloudSchedulerSource( + params?: Params$Resource$Projects$Locations$Cloudschedulersources$Replacecloudschedulersource, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Eventtypes$List, + ): GaxiosPromise; + replaceCloudSchedulerSource( + params: Params$Resource$Projects$Locations$Cloudschedulersources$Replacecloudschedulersource, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Eventtypes$List, - callback: BodyResponseCallback + replaceCloudSchedulerSource( + params: Params$Resource$Projects$Locations$Cloudschedulersources$Replacecloudschedulersource, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + replaceCloudSchedulerSource( + callback: BodyResponseCallback + ): void; + replaceCloudSchedulerSource( paramsOrCallback?: - | Params$Resource$Projects$Locations$Eventtypes$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudschedulersources$Replacecloudschedulersource + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Eventtypes$List; + {}) as Params$Resource$Projects$Locations$Cloudschedulersources$Replacecloudschedulersource; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Eventtypes$List; + params = {} as Params$Resource$Projects$Locations$Cloudschedulersources$Replacecloudschedulersource; options = {}; } @@ -7974,28 +7907,25 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/eventtypes').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PUT', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Eventtypes$Get + export interface Params$Resource$Projects$Locations$Cloudschedulersources$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -8003,11 +7933,52 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. + * Required. The project ID or project number in which this cloudschedulersource should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudSchedulerSource; + } + export interface Params$Resource$Projects$Locations$Cloudschedulersources$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * Required. The name of the cloudschedulersource being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Cloudschedulersources$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the cloudschedulersource being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Eventtypes$List + export interface Params$Resource$Projects$Locations$Cloudschedulersources$List extends StandardParameters { /** * Auth client or API Key for the request @@ -8035,7 +8006,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the EventTypes should be listed. + * Required. The project ID or project number from which the cloudschedulersources should be listed. */ parent?: string; /** @@ -8047,54 +8018,73 @@ export namespace run_v1alpha1 { */ watch?: boolean; } + export interface Params$Resource$Projects$Locations$Cloudschedulersources$Replacecloudschedulersource + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the cloudschedulersource being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CloudSchedulerSource; + } - export class Resource$Projects$Locations$Pubsubs { + export class Resource$Projects$Locations$Cloudstoragesources { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.pubsubs.create - * @desc Creates a new pubsub. - * @alias run.projects.locations.pubsubs.create + * run.projects.locations.cloudstoragesources.create + * @desc Creates a new cloudstoragesource. + * @alias run.projects.locations.cloudstoragesources.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this pubsub should be created. - * @param {().PubSub} params.requestBody Request body data + * @param {string} params.parent Required. The project ID or project number in which this cloudstoragesource should be created. + * @param {().CloudStorageSource} params.requestBody Request 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$Pubsubs$Create, + params?: Params$Resource$Projects$Locations$Cloudstoragesources$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Pubsubs$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudstoragesources$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Pubsubs$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudstoragesources$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Cloudstoragesources$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$Create; + {}) as Params$Resource$Projects$Locations$Cloudstoragesources$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$Create; + params = {} as Params$Resource$Projects$Locations$Cloudstoragesources$Create; options = {}; } @@ -8107,7 +8097,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/pubsubs').replace( + url: (rootUrl + '/v1alpha1/{+parent}/cloudstoragesources').replace( /([^:]\/)\/+/g, '$1' ), @@ -8121,55 +8111,55 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.pubsubs.delete - * @desc Rpc to delete a pubsub. - * @alias run.projects.locations.pubsubs.delete + * run.projects.locations.cloudstoragesources.delete + * @desc Rpc to delete a cloudstoragesource. + * @alias run.projects.locations.cloudstoragesources.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name Required. The name of the cloudstoragesource being deleted. If needed, replace {namespace_id} with the project ID. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [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$Pubsubs$Delete, + params?: Params$Resource$Projects$Locations$Cloudstoragesources$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Pubsubs$Delete, + params: Params$Resource$Projects$Locations$Cloudstoragesources$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Pubsubs$Delete, + params: Params$Resource$Projects$Locations$Cloudstoragesources$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$Delete + | Params$Resource$Projects$Locations$Cloudstoragesources$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$Delete; + {}) as Params$Resource$Projects$Locations$Cloudstoragesources$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$Delete; + params = {} as Params$Resource$Projects$Locations$Cloudstoragesources$Delete; options = {}; } @@ -8200,45 +8190,47 @@ export namespace run_v1alpha1 { } /** - * run.projects.locations.pubsubs.get - * @desc Rpc to get information about a pubsub. - * @alias run.projects.locations.pubsubs.get + * run.projects.locations.cloudstoragesources.get + * @desc Rpc to get information about a cloudstoragesource. + * @alias run.projects.locations.cloudstoragesources.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name Required. The name of the cloudstoragesource being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Pubsubs$Get, + params?: Params$Resource$Projects$Locations$Cloudstoragesources$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Pubsubs$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudstoragesources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Pubsubs$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudstoragesources$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Cloudstoragesources$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$Get; + {}) as Params$Resource$Projects$Locations$Cloudstoragesources$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$Get; + params = {} as Params$Resource$Projects$Locations$Cloudstoragesources$Get; options = {}; } @@ -8262,16 +8254,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.pubsubs.list - * @desc Rpc to list pubsubs. - * @alias run.projects.locations.pubsubs.list + * run.projects.locations.cloudstoragesources.list + * @desc Rpc to list cloudstoragesources. + * @alias run.projects.locations.cloudstoragesources.list * @memberOf! () * * @param {object} params Parameters for request @@ -8280,7 +8272,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the pubsubs should be listed. + * @param {string} params.parent Required. The project ID or project number from which the cloudstoragesources should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8288,35 +8280,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Pubsubs$List, + params?: Params$Resource$Projects$Locations$Cloudstoragesources$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Cloudstoragesources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; list( - params: Params$Resource$Projects$Locations$Pubsubs$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Cloudstoragesources$List, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Pubsubs$List, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Cloudstoragesources$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$List; + {}) as Params$Resource$Projects$Locations$Cloudstoragesources$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$List; + params = {} as Params$Resource$Projects$Locations$Cloudstoragesources$List; options = {}; } @@ -8329,7 +8325,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/pubsubs').replace( + url: (rootUrl + '/v1alpha1/{+parent}/cloudstoragesources').replace( /([^:]\/)\/+/g, '$1' ), @@ -8343,53 +8339,62 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * run.projects.locations.pubsubs.replacePubSub - * @desc Rpc to replace a pubsub. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.projects.locations.pubsubs.replacePubSub + * run.projects.locations.cloudstoragesources.replaceCloudStorageSource + * @desc Rpc to replace a cloudstoragesource. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.cloudstoragesources.replaceCloudStorageSource * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().PubSub} params.requestBody Request body data + * @param {string} params.name Required. The name of the cloudstoragesource being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {().CloudStorageSource} params.requestBody Request 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 */ - replacePubSub( - params?: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, + replaceCloudStorageSource( + params?: Params$Resource$Projects$Locations$Cloudstoragesources$Replacecloudstoragesource, options?: MethodOptions - ): GaxiosPromise; - replacePubSub( - params: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replacePubSub( - params: Params$Resource$Projects$Locations$Pubsubs$Replacepubsub, - callback: BodyResponseCallback - ): void; - replacePubSub(callback: BodyResponseCallback): void; - replacePubSub( + ): GaxiosPromise; + replaceCloudStorageSource( + params: Params$Resource$Projects$Locations$Cloudstoragesources$Replacecloudstoragesource, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replaceCloudStorageSource( + params: Params$Resource$Projects$Locations$Cloudstoragesources$Replacecloudstoragesource, + callback: BodyResponseCallback + ): void; + replaceCloudStorageSource( + callback: BodyResponseCallback + ): void; + replaceCloudStorageSource( paramsOrCallback?: - | Params$Resource$Projects$Locations$Pubsubs$Replacepubsub - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Cloudstoragesources$Replacecloudstoragesource + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Pubsubs$Replacepubsub; + {}) as Params$Resource$Projects$Locations$Cloudstoragesources$Replacecloudstoragesource; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Pubsubs$Replacepubsub; + params = {} as Params$Resource$Projects$Locations$Cloudstoragesources$Replacecloudstoragesource; options = {}; } @@ -8413,14 +8418,14 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Pubsubs$Create + export interface Params$Resource$Projects$Locations$Cloudstoragesources$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -8428,16 +8433,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this pubsub should be created. + * Required. The project ID or project number in which this cloudstoragesource should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$PubSub; + requestBody?: Schema$CloudStorageSource; } - export interface Params$Resource$Projects$Locations$Pubsubs$Delete + export interface Params$Resource$Projects$Locations$Cloudstoragesources$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -8453,7 +8458,7 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the pubsub being deleted. If needed, replace {namespace_id} with the project ID. + * Required. The name of the cloudstoragesource being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; /** @@ -8461,7 +8466,7 @@ export namespace run_v1alpha1 { */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Pubsubs$Get + export interface Params$Resource$Projects$Locations$Cloudstoragesources$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -8469,11 +8474,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * Required. The name of the cloudstoragesource being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Pubsubs$List + export interface Params$Resource$Projects$Locations$Cloudstoragesources$List extends StandardParameters { /** * Auth client or API Key for the request @@ -8501,7 +8506,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the pubsubs should be listed. + * Required. The project ID or project number from which the cloudstoragesources should be listed. */ parent?: string; /** @@ -8513,7 +8518,7 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Projects$Locations$Pubsubs$Replacepubsub + export interface Params$Resource$Projects$Locations$Cloudstoragesources$Replacecloudstoragesource extends StandardParameters { /** * Auth client or API Key for the request @@ -8521,135 +8526,64 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the pubsub being retrieved. If needed, replace {namespace_id} with the project ID. + * Required. The name of the cloudstoragesource being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$PubSub; + requestBody?: Schema$CloudStorageSource; } - export class Resource$Projects$Locations$Revisions { + export class Resource$Projects$Locations$Configurations { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.revisions.delete - * @desc Rpc to delete a revision. - * @alias run.projects.locations.revisions.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. - * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. - * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - * @param {object} [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$Revisions$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Locations$Revisions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Locations$Revisions$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.revisions.get - * @desc Rpc to get information about a revision. - * @alias run.projects.locations.revisions.get + * run.projects.locations.configurations.get + * @desc Rpc to get information about a configuration. + * @alias run.projects.locations.configurations.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Revisions$Get, + params?: Params$Resource$Projects$Locations$Configurations$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Revisions$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Configurations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Revisions$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Configurations$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Configurations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$Get; + {}) as Params$Resource$Projects$Locations$Configurations$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$Get; + params = {} as Params$Resource$Projects$Locations$Configurations$Get; options = {}; } @@ -8673,16 +8607,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.revisions.list - * @desc Rpc to list revisions. - * @alias run.projects.locations.revisions.list + * run.projects.locations.configurations.list + * @desc Rpc to list configurations. + * @alias run.projects.locations.configurations.list * @memberOf! () * * @param {object} params Parameters for request @@ -8691,7 +8625,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the revisions should be listed. + * @param {string} params.parent The project ID or project number from which the configurations should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8699,37 +8633,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Revisions$List, + params?: Params$Resource$Projects$Locations$Configurations$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Revisions$List, + params: Params$Resource$Projects$Locations$Configurations$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Revisions$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Configurations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Revisions$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Configurations$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Revisions$List; + {}) as Params$Resource$Projects$Locations$Configurations$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Revisions$List; + params = {} as Params$Resource$Projects$Locations$Configurations$List; options = {}; } @@ -8742,7 +8678,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/revisions').replace( + url: (rootUrl + '/v1alpha1/{+parent}/configurations').replace( /([^:]\/)\/+/g, '$1' ), @@ -8756,42 +8692,17 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Revisions$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Cloud Run currently ignores this parameter. - */ - apiVersion?: string; - /** - * Cloud Run currently ignores this parameter. - */ - kind?: string; - /** - * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; - /** - * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - */ - propagationPolicy?: string; - } - export interface Params$Resource$Projects$Locations$Revisions$Get + export interface Params$Resource$Projects$Locations$Configurations$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -8799,11 +8710,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the configuration being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Revisions$List + export interface Params$Resource$Projects$Locations$Configurations$List extends StandardParameters { /** * Auth client or API Key for the request @@ -8831,7 +8742,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the revisions should be listed. + * The project ID or project number from which the configurations should be listed. */ parent?: string; /** @@ -8844,52 +8755,202 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Projects$Locations$Routes { + export class Resource$Projects$Locations$Domainmappings { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.routes.get - * @desc Rpc to get information about a route. - * @alias run.projects.locations.routes.get + * run.projects.locations.domainmappings.create + * @desc Creates a new domain mapping. + * @alias run.projects.locations.domainmappings.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.parent The project ID or project number in which this domain mapping should be created. + * @param {().DomainMapping} params.requestBody Request 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$Domainmappings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Domainmappings$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Domainmappings$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.domainmappings.delete + * @desc Rpc to delete a domain mapping. + * @alias run.projects.locations.domainmappings.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. + * @param {string=} params.kind Cloud Run currently ignores this parameter. + * @param {string} params.name The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + * @param {object} [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$Domainmappings$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Domainmappings$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Domainmappings$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Domainmappings$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Domainmappings$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.domainmappings.get + * @desc Rpc to get information about a domain mapping. + * @alias run.projects.locations.domainmappings.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Routes$Get, + params?: Params$Resource$Projects$Locations$Domainmappings$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Routes$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Domainmappings$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Routes$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Domainmappings$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Routes$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Domainmappings$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Routes$Get; + {}) as Params$Resource$Projects$Locations$Domainmappings$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Routes$Get; + params = {} as Params$Resource$Projects$Locations$Domainmappings$Get; options = {}; } @@ -8913,16 +8974,16 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.routes.list - * @desc Rpc to list routes. - * @alias run.projects.locations.routes.list + * run.projects.locations.domainmappings.list + * @desc Rpc to list domain mappings. + * @alias run.projects.locations.domainmappings.list * @memberOf! () * * @param {object} params Parameters for request @@ -8931,7 +8992,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the routes should be listed. + * @param {string} params.parent The project ID or project number from which the domain mappings should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -8939,35 +9000,39 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Routes$List, + params?: Params$Resource$Projects$Locations$Domainmappings$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Domainmappings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; list( - params: Params$Resource$Projects$Locations$Routes$List, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Domainmappings$List, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Routes$List, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Routes$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Domainmappings$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Routes$List; + {}) as Params$Resource$Projects$Locations$Domainmappings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Routes$List; + params = {} as Params$Resource$Projects$Locations$Domainmappings$List; options = {}; } @@ -8980,7 +9045,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/routes').replace( + url: (rootUrl + '/v1alpha1/{+parent}/domainmappings').replace( /([^:]\/)\/+/g, '$1' ), @@ -8994,14 +9059,17 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Routes$Get + export interface Params$Resource$Projects$Locations$Domainmappings$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -9009,11 +9077,56 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. + * The project ID or project number in which this domain mapping should be created. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DomainMapping; + } + export interface Params$Resource$Projects$Locations$Domainmappings$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the domain mapping being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Routes$List + export interface Params$Resource$Projects$Locations$Domainmappings$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the domain mapping being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Domainmappings$List extends StandardParameters { /** * Auth client or API Key for the request @@ -9041,7 +9154,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the routes should be listed. + * The project ID or project number from which the domain mappings should be listed. */ parent?: string; /** @@ -9054,95 +9167,22 @@ export namespace run_v1alpha1 { watch?: boolean; } - export class Resource$Projects$Locations$Services { + export class Resource$Projects$Locations$Revisions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.services.create - * @desc Rpc to create a service. - * @alias run.projects.locations.services.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this service should be created. - * @param {().Service} params.requestBody Request 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$Services$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Locations$Services$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Projects$Locations$Services$Create, - callback: BodyResponseCallback - ): void; - create(callback: BodyResponseCallback): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+parent}/services').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.services.delete - * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. - * @alias run.projects.locations.services.delete + * run.projects.locations.revisions.delete + * @desc Rpc to delete a revision. + * @alias run.projects.locations.revisions.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the service being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9150,33 +9190,33 @@ export namespace run_v1alpha1 { * @return {object} Request object */ delete( - params?: Params$Resource$Projects$Locations$Services$Delete, + params?: Params$Resource$Projects$Locations$Revisions$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Services$Delete, + params: Params$Resource$Projects$Locations$Revisions$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Services$Delete, + params: Params$Resource$Projects$Locations$Revisions$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Delete + | Params$Resource$Projects$Locations$Revisions$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Delete; + {}) as Params$Resource$Projects$Locations$Revisions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Delete; + params = {} as Params$Resource$Projects$Locations$Revisions$Delete; options = {}; } @@ -9207,115 +9247,45 @@ export namespace run_v1alpha1 { } /** - * run.projects.locations.services.get - * @desc Rpc to get information about a service. - * @alias run.projects.locations.services.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Locations$Services$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Locations$Services$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Projects$Locations$Services$Get, - callback: BodyResponseCallback - ): void; - get(callback: BodyResponseCallback): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * run.projects.locations.services.getIamPolicy - * @desc Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies. - * @alias run.projects.locations.services.getIamPolicy + * run.projects.locations.revisions.get + * @desc Rpc to get information about a revision. + * @alias run.projects.locations.revisions.get * @memberOf! () * * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - * @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 {string} params.name The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - getIamPolicy( - params?: Params$Resource$Projects$Locations$Services$Getiampolicy, + get( + params?: Params$Resource$Projects$Locations$Revisions$Get, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Services$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Revisions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Services$Getiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Revisions$Get, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Revisions$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Revisions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Revisions$Get; options = {}; } @@ -9328,30 +9298,27 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:getIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.list - * @desc Rpc to list services. - * @alias run.projects.locations.services.list + * run.projects.locations.revisions.list + * @desc Rpc to list revisions. + * @alias run.projects.locations.revisions.list * @memberOf! () * * @param {object} params Parameters for request @@ -9360,7 +9327,7 @@ export namespace run_v1alpha1 { * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the services should be listed. + * @param {string} params.parent The project ID or project number from which the revisions should be listed. * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -9368,37 +9335,37 @@ export namespace run_v1alpha1 { * @return {object} Request object */ list( - params?: Params$Resource$Projects$Locations$Services$List, + params?: Params$Resource$Projects$Locations$Revisions$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Services$List, + params: Params$Resource$Projects$Locations$Revisions$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Services$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Revisions$List, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$List - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Revisions$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$List; + {}) as Params$Resource$Projects$Locations$Revisions$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$List; + params = {} as Params$Resource$Projects$Locations$Revisions$List; options = {}; } @@ -9411,7 +9378,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/services').replace( + url: (rootUrl + '/v1alpha1/{+parent}/revisions').replace( /([^:]\/)\/+/g, '$1' ), @@ -9425,123 +9392,140 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Projects$Locations$Revisions$Delete + extends StandardParameters { /** - * run.projects.locations.services.replaceService - * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.projects.locations.services.replaceService - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. - * @param {().Service} params.requestBody Request 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 + * Auth client or API Key for the request */ - replaceService( - params?: Params$Resource$Projects$Locations$Services$Replaceservice, - options?: MethodOptions - ): GaxiosPromise; - replaceService( - params: Params$Resource$Projects$Locations$Services$Replaceservice, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceService( - params: Params$Resource$Projects$Locations$Services$Replaceservice, - callback: BodyResponseCallback - ): void; - replaceService(callback: BodyResponseCallback): void; - replaceService( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Replaceservice - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Replaceservice; - let options = (optionsOrCallback || {}) as MethodOptions; + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Replaceservice; - options = {}; - } + /** + * Cloud Run currently ignores this parameter. + */ + apiVersion?: string; + /** + * Cloud Run currently ignores this parameter. + */ + kind?: string; + /** + * The name of the revision being deleted. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; + /** + * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. + */ + propagationPolicy?: string; + } + export interface Params$Resource$Projects$Locations$Revisions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } + /** + * The name of the revision being retrieved. If needed, replace {namespace_id} with the project ID. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Revisions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } + /** + * Optional encoded string to continue paging. + */ + continue?: string; + /** + * Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + */ + fieldSelector?: string; + /** + * Not currently used by Cloud Run. + */ + includeUninitialized?: boolean; + /** + * Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + */ + labelSelector?: string; + /** + * The maximum number of records that should be returned. + */ + limit?: number; + /** + * The project ID or project number from which the revisions should be listed. + */ + parent?: string; + /** + * The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + */ + resourceVersion?: string; + /** + * Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + */ + watch?: boolean; + } + + export class Resource$Projects$Locations$Routes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; } /** - * run.projects.locations.services.setIamPolicy - * @desc Sets the IAM Access control policy for the specified Service. Overwrites any existing policy. - * @alias run.projects.locations.services.setIamPolicy + * run.projects.locations.routes.get + * @desc Rpc to get information about a route. + * @alias run.projects.locations.routes.get * @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.requestBody Request body data + * @param {string} params.name The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - setIamPolicy( - params?: Params$Resource$Projects$Locations$Services$Setiampolicy, + get( + params?: Params$Resource$Projects$Locations$Routes$Get, options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$Projects$Locations$Services$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Routes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - setIamPolicy( - params: Params$Resource$Projects$Locations$Services$Setiampolicy, - callback: BodyResponseCallback + get( + params: Params$Resource$Projects$Locations$Routes$Get, + callback: BodyResponseCallback ): void; - setIamPolicy(callback: BodyResponseCallback): void; - setIamPolicy( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Routes$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Setiampolicy; + {}) as Params$Resource$Projects$Locations$Routes$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Setiampolicy; + params = {} as Params$Resource$Projects$Locations$Routes$Get; options = {}; } @@ -9554,73 +9538,72 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.services.testIamPermissions - * @desc Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. - * @alias run.projects.locations.services.testIamPermissions + * run.projects.locations.routes.list + * @desc Rpc to list routes. + * @alias run.projects.locations.routes.list * @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.requestBody Request body data + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the routes should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - testIamPermissions( - params?: Params$Resource$Projects$Locations$Services$Testiampermissions, + list( + params?: Params$Resource$Projects$Locations$Routes$List, options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$Projects$Locations$Services$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - testIamPermissions( - params: Params$Resource$Projects$Locations$Services$Testiampermissions, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Routes$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - testIamPermissions( - callback: BodyResponseCallback + list( + params: Params$Resource$Projects$Locations$Routes$List, + callback: BodyResponseCallback ): void; - testIamPermissions( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Services$Testiampermissions - | BodyResponseCallback, + | Params$Resource$Projects$Locations$Routes$List + | BodyResponseCallback, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Services$Testiampermissions; + {}) as Params$Resource$Projects$Locations$Routes$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Services$Testiampermissions; + params = {} as Params$Resource$Projects$Locations$Routes$List; options = {}; } @@ -9633,76 +9616,28 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+resource}:testIamPermissions').replace( + url: (rootUrl + '/v1alpha1/{+parent}/routes').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback - ); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Projects$Locations$Services$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The project ID or project number in which this service should be created. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Service; - } - export interface Params$Resource$Projects$Locations$Services$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Cloud Run currently ignores this parameter. - */ - apiVersion?: string; - /** - * Cloud Run currently ignores this parameter. - */ - kind?: string; - /** - * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - /** - * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. - */ - orphanDependents?: boolean; - /** - * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. - */ - propagationPolicy?: string; - } - export interface Params$Resource$Projects$Locations$Services$Get + export interface Params$Resource$Projects$Locations$Routes$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -9710,27 +9645,11 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the route being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Services$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$Projects$Locations$Services$List + export interface Params$Resource$Projects$Locations$Routes$List extends StandardParameters { /** * Auth client or API Key for the request @@ -9758,7 +9677,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the services should be listed. + * The project ID or project number from which the routes should be listed. */ parent?: string; /** @@ -9770,105 +9689,54 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Projects$Locations$Services$Replaceservice - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Service; - } - export interface Params$Resource$Projects$Locations$Services$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$Services$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$Storages { + export class Resource$Projects$Locations$Services { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * run.projects.locations.storages.create - * @desc Creates a new storage. - * @alias run.projects.locations.storages.create + * run.projects.locations.services.create + * @desc Rpc to create a service. + * @alias run.projects.locations.services.create * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.parent The project ID or project number in which this storage should be created. - * @param {().Storage} params.requestBody Request body data + * @param {string} params.parent The project ID or project number in which this service should be created. + * @param {().Service} params.requestBody Request 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$Storages$Create, + params?: Params$Resource$Projects$Locations$Services$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Projects$Locations$Storages$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Services$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Projects$Locations$Storages$Create, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Services$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Storages$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Services$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Storages$Create; + {}) as Params$Resource$Projects$Locations$Services$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Storages$Create; + params = {} as Params$Resource$Projects$Locations$Services$Create; options = {}; } @@ -9881,7 +9749,7 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/storages').replace( + url: (rootUrl + '/v1alpha1/{+parent}/services').replace( /([^:]\/)\/+/g, '$1' ), @@ -9895,55 +9763,56 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.storages.delete - * @desc Rpc to delete a storage. - * @alias run.projects.locations.storages.delete + * run.projects.locations.services.delete + * @desc Rpc to delete a service. This will cause the Service to stop serving traffic and will delete the child entities like Routes, Configurations and Revisions. + * @alias run.projects.locations.services.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.apiVersion Cloud Run currently ignores this parameter. * @param {string=} params.kind Cloud Run currently ignores this parameter. - * @param {string} params.name The name of the storage being deleted. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the service being deleted. If needed, replace {namespace_id} with the project ID. + * @param {boolean=} params.orphanDependents Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. * @param {string=} params.propagationPolicy Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. * @param {object} [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$Storages$Delete, + params?: Params$Resource$Projects$Locations$Services$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Storages$Delete, + params: Params$Resource$Projects$Locations$Services$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Storages$Delete, + params: Params$Resource$Projects$Locations$Services$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Storages$Delete + | Params$Resource$Projects$Locations$Services$Delete | BodyResponseCallback, optionsOrCallback?: MethodOptions | BodyResponseCallback, callback?: BodyResponseCallback ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Storages$Delete; + {}) as Params$Resource$Projects$Locations$Services$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Storages$Delete; + params = {} as Params$Resource$Projects$Locations$Services$Delete; options = {}; } @@ -9974,45 +9843,271 @@ export namespace run_v1alpha1 { } /** - * run.projects.locations.storages.get - * @desc Rpc to get information about a storage. - * @alias run.projects.locations.storages.get + * run.projects.locations.services.get + * @desc Rpc to get information about a service. + * @alias run.projects.locations.services.get * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. + * @param {string} params.name The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get( - params?: Params$Resource$Projects$Locations$Storages$Get, + params?: Params$Resource$Projects$Locations$Services$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Services$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Services$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; get( - params: Params$Resource$Projects$Locations$Storages$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.getIamPolicy + * @desc Get the IAM Access Control policy currently in effect for the given Cloud Run service. This result does not include any inherited policies. + * @alias run.projects.locations.services.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @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$Services$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Services$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Services$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+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); + } + } + + /** + * run.projects.locations.services.list + * @desc Rpc to list services. + * @alias run.projects.locations.services.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. + * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. + * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. + * @param {integer=} params.limit The maximum number of records that should be returned. + * @param {string} params.parent The project ID or project number from which the services should be listed. + * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. + * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Services$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Services$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Services$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Services$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Services$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Services$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}/services').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * run.projects.locations.services.replaceService + * @desc Rpc to replace a service. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. + * @alias run.projects.locations.services.replaceService + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the service being replaced. If needed, replace {namespace_id} with the project ID. + * @param {().Service} params.requestBody Request 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 + */ + replaceService( + params?: Params$Resource$Projects$Locations$Services$Replaceservice, + options?: MethodOptions + ): GaxiosPromise; + replaceService( + params: Params$Resource$Projects$Locations$Services$Replaceservice, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Projects$Locations$Storages$Get, - callback: BodyResponseCallback + replaceService( + params: Params$Resource$Projects$Locations$Services$Replaceservice, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + replaceService(callback: BodyResponseCallback): void; + replaceService( paramsOrCallback?: - | Params$Resource$Projects$Locations$Storages$Get - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Services$Replaceservice + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Storages$Get; + {}) as Params$Resource$Projects$Locations$Services$Replaceservice; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Storages$Get; + params = {} as Params$Resource$Projects$Locations$Services$Replaceservice; options = {}; } @@ -10026,7 +10121,7 @@ export namespace run_v1alpha1 { options: Object.assign( { url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PUT', }, options ), @@ -10036,63 +10131,53 @@ export namespace run_v1alpha1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * run.projects.locations.storages.list - * @desc Rpc to list storages. - * @alias run.projects.locations.storages.list + * run.projects.locations.services.setIamPolicy + * @desc Sets the IAM Access control policy for the specified Service. Overwrites any existing policy. + * @alias run.projects.locations.services.setIamPolicy * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. - * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. - * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. - * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. - * @param {integer=} params.limit The maximum number of records that should be returned. - * @param {string} params.parent The project ID or project number from which the storages should be listed. - * @param {string=} params.resourceVersion The baseline resource version from which the list or watch operation should start. Not currently used by Cloud Run. - * @param {boolean=} params.watch Flag that indicates that the client expects to watch this resource as well. Not currently used by Cloud Run. + * @param {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.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - list( - params?: Params$Resource$Projects$Locations$Storages$List, + setIamPolicy( + params?: Params$Resource$Projects$Locations$Services$Setiampolicy, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Projects$Locations$Storages$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Services$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Projects$Locations$Storages$List, - callback: BodyResponseCallback + setIamPolicy( + params: Params$Resource$Projects$Locations$Services$Setiampolicy, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( paramsOrCallback?: - | Params$Resource$Projects$Locations$Storages$List - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Services$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Storages$List; + {}) as Params$Resource$Projects$Locations$Services$Setiampolicy; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Storages$List; + params = {} as Params$Resource$Projects$Locations$Services$Setiampolicy; options = {}; } @@ -10105,67 +10190,73 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+parent}/storages').replace( + url: (rootUrl + '/v1alpha1/{+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); } } /** - * run.projects.locations.storages.replaceStorage - * @desc Rpc to replace a storage. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.projects.locations.storages.replaceStorage + * run.projects.locations.services.testIamPermissions + * @desc Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call. + * @alias run.projects.locations.services.testIamPermissions * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().Storage} params.requestBody 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.requestBody Request 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 */ - replaceStorage( - params?: Params$Resource$Projects$Locations$Storages$Replacestorage, + testIamPermissions( + params?: Params$Resource$Projects$Locations$Services$Testiampermissions, options?: MethodOptions - ): GaxiosPromise; - replaceStorage( - params: Params$Resource$Projects$Locations$Storages$Replacestorage, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceStorage( - params: Params$Resource$Projects$Locations$Storages$Replacestorage, - callback: BodyResponseCallback - ): void; - replaceStorage(callback: BodyResponseCallback): void; - replaceStorage( + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Services$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Services$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( paramsOrCallback?: - | Params$Resource$Projects$Locations$Storages$Replacestorage - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Projects$Locations$Services$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Storages$Replacestorage; + {}) as Params$Resource$Projects$Locations$Services$Testiampermissions; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Storages$Replacestorage; + params = {} as Params$Resource$Projects$Locations$Services$Testiampermissions; options = {}; } @@ -10178,25 +10269,31 @@ export namespace run_v1alpha1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', + url: (rootUrl + '/v1alpha1/{+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$Storages$Create + export interface Params$Resource$Projects$Locations$Services$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -10204,16 +10301,16 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The project ID or project number in which this storage should be created. + * The project ID or project number in which this service should be created. */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$Storage; + requestBody?: Schema$Service; } - export interface Params$Resource$Projects$Locations$Storages$Delete + export interface Params$Resource$Projects$Locations$Services$Delete extends StandardParameters { /** * Auth client or API Key for the request @@ -10229,15 +10326,19 @@ export namespace run_v1alpha1 { */ kind?: string; /** - * The name of the storage being deleted. If needed, replace {namespace_id} with the project ID. + * The name of the service being deleted. If needed, replace {namespace_id} with the project ID. */ name?: string; + /** + * Deprecated. Specifies the cascade behavior on delete. Cloud Run only supports cascading behavior, so this must be false. This attribute is deprecated, and is now replaced with PropagationPolicy See https://github.com/kubernetes/kubernetes/issues/46659 for more info. + */ + orphanDependents?: boolean; /** * Specifies the propagation policy of delete. Cloud Run currently ignores this setting, and deletes in the background. Please see kubernetes.io/docs/concepts/workloads/controllers/garbage-collection/ for more information. */ propagationPolicy?: string; } - export interface Params$Resource$Projects$Locations$Storages$Get + export interface Params$Resource$Projects$Locations$Services$Get extends StandardParameters { /** * Auth client or API Key for the request @@ -10245,11 +10346,27 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the service being retrieved. If needed, replace {namespace_id} with the project ID. */ name?: string; } - export interface Params$Resource$Projects$Locations$Storages$List + export interface Params$Resource$Projects$Locations$Services$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Services$List extends StandardParameters { /** * Auth client or API Key for the request @@ -10277,7 +10394,7 @@ export namespace run_v1alpha1 { */ limit?: number; /** - * The project ID or project number from which the storages should be listed. + * The project ID or project number from which the services should be listed. */ parent?: string; /** @@ -10289,7 +10406,7 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Projects$Locations$Storages$Replacestorage + export interface Params$Resource$Projects$Locations$Services$Replaceservice extends StandardParameters { /** * Auth client or API Key for the request @@ -10297,14 +10414,48 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the storage being retrieved. If needed, replace {namespace_id} with the project ID. + * The name of the service being replaced. If needed, replace {namespace_id} with the project ID. */ name?: string; /** * Request body metadata */ - requestBody?: Schema$Storage; + requestBody?: Schema$Service; + } + export interface Params$Resource$Projects$Locations$Services$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$Services$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$Triggers { @@ -10534,7 +10685,7 @@ export namespace run_v1alpha1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.continue Optional encoded string to continue paging. + * @param {string=} params.continue Optional. Encoded string to continue paging. * @param {string=} params.fieldSelector Allows to filter resources based on a specific value for a field name. Send this in a query string format. i.e. 'metadata.name%3Dlorem'. Not currently used by Cloud Run. * @param {boolean=} params.includeUninitialized Not currently used by Cloud Run. * @param {string=} params.labelSelector Allows to filter resources based on a label. Supported operations are =, !=, exists, in, and notIn. @@ -10609,76 +10760,6 @@ export namespace run_v1alpha1 { return createAPIRequest(parameters); } } - - /** - * run.projects.locations.triggers.replaceTrigger - * @desc Rpc to replace a trigger. Only the spec and metadata labels and annotations are modifiable. After the Update request, Cloud Run will work to make the 'status' match the requested 'spec'. May provide metadata.resourceVersion to enforce update from last read for optimistic concurrency control. - * @alias run.projects.locations.triggers.replaceTrigger - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. - * @param {().Trigger} params.requestBody Request 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 - */ - replaceTrigger( - params?: Params$Resource$Projects$Locations$Triggers$Replacetrigger, - options?: MethodOptions - ): GaxiosPromise; - replaceTrigger( - params: Params$Resource$Projects$Locations$Triggers$Replacetrigger, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - replaceTrigger( - params: Params$Resource$Projects$Locations$Triggers$Replacetrigger, - callback: BodyResponseCallback - ): void; - replaceTrigger(callback: BodyResponseCallback): void; - replaceTrigger( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Triggers$Replacetrigger - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Triggers$Replacetrigger; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Triggers$Replacetrigger; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://run.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } } export interface Params$Resource$Projects$Locations$Triggers$Create @@ -10742,7 +10823,7 @@ export namespace run_v1alpha1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Optional encoded string to continue paging. + * Optional. Encoded string to continue paging. */ continue?: string; /** @@ -10774,21 +10855,4 @@ export namespace run_v1alpha1 { */ watch?: boolean; } - export interface Params$Resource$Projects$Locations$Triggers$Replacetrigger - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the trigger being retrieved. If needed, replace {namespace_id} with the project ID. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$Trigger; - } } diff --git a/src/apis/runtimeconfig/v1beta1.ts b/src/apis/runtimeconfig/v1beta1.ts index d6f098ad72..e725fda02c 100644 --- a/src/apis/runtimeconfig/v1beta1.ts +++ b/src/apis/runtimeconfig/v1beta1.ts @@ -159,23 +159,23 @@ export namespace runtimeconfig_v1beta1 { cardinality?: Schema$Cardinality; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/safebrowsing/v4.ts b/src/apis/safebrowsing/v4.ts index e13dc358c1..9480ec369d 100644 --- a/src/apis/safebrowsing/v4.ts +++ b/src/apis/safebrowsing/v4.ts @@ -162,7 +162,7 @@ export namespace safebrowsing_v4 { */ language?: string | null; /** - * Sets the maximum number of entries that the client is willing to have in the local database. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set. + * Sets the maximum number of entries that the client is willing to have in the local database for the specified list. This should be a power of 2 between 2**10 and 2**20. If zero, no database size limit is set. */ maxDatabaseEntries?: number | null; /** diff --git a/src/apis/gamesConfiguration/README.md b/src/apis/searchconsole/README.md similarity index 80% rename from src/apis/gamesConfiguration/README.md rename to src/apis/searchconsole/README.md index 31873faaa2..5b106abc8b 100644 --- a/src/apis/gamesConfiguration/README.md +++ b/src/apis/searchconsole/README.md @@ -1,8 +1,8 @@ Google Inc. logo -# gamesConfiguration +# searchconsole -> The Publishing API for Google Play Game Services. +> Provides tools for running validation tests against single URLs ## Installation @@ -19,17 +19,17 @@ This library can be used in a browser. To prepare a single file bundle, clone th [repository](https://github.com/googleapis/google-api-nodejs-client) and run ```sh -$ cd src/apis/gamesConfiguration +$ cd src/apis/searchconsole $ npm install $ npm run webpack ``` -The generated bundle will be written to `dist/gamesConfiguration.min.js`. Use it from your HTML file: +The generated bundle will be written to `dist/searchconsole.min.js`. Use it from your HTML file: ```html - + ``` diff --git a/src/apis/gamesConfiguration/index.ts b/src/apis/searchconsole/index.ts similarity index 54% rename from src/apis/gamesConfiguration/index.ts rename to src/apis/searchconsole/index.ts index 6b24fb5f93..99cb436c6c 100644 --- a/src/apis/gamesConfiguration/index.ts +++ b/src/apis/searchconsole/index.ts @@ -14,27 +14,21 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {gamesConfiguration_v1configuration} from './v1configuration'; +import {searchconsole_v1} from './v1'; export const VERSIONS = { - v1configuration: gamesConfiguration_v1configuration.Gamesconfiguration, + v1: searchconsole_v1.Searchconsole, }; -export function gamesConfiguration( - version: 'v1configuration' -): gamesConfiguration_v1configuration.Gamesconfiguration; -export function gamesConfiguration( - options: gamesConfiguration_v1configuration.Options -): gamesConfiguration_v1configuration.Gamesconfiguration; -export function gamesConfiguration< - T = gamesConfiguration_v1configuration.Gamesconfiguration ->( +export function searchconsole(version: 'v1'): searchconsole_v1.Searchconsole; +export function searchconsole( + options: searchconsole_v1.Options +): searchconsole_v1.Searchconsole; +export function searchconsole( this: GoogleConfigurable, - versionOrOptions: - | 'v1configuration' - | gamesConfiguration_v1configuration.Options + versionOrOptions: 'v1' | searchconsole_v1.Options ) { - return getAPI('gamesConfiguration', versionOrOptions, VERSIONS, this); + return getAPI('searchconsole', versionOrOptions, VERSIONS, this); } const auth = new AuthPlus(); diff --git a/src/apis/servicebroker/package.json b/src/apis/searchconsole/package.json similarity index 93% rename from src/apis/servicebroker/package.json rename to src/apis/searchconsole/package.json index df50811b0d..7002426fa4 100644 --- a/src/apis/servicebroker/package.json +++ b/src/apis/searchconsole/package.json @@ -1,7 +1,7 @@ { - "name": "@google/servicebroker", + "name": "@google/searchconsole", "version": "0.1.0", - "description": "servicebroker", + "description": "searchconsole", "main": "build/index.js", "types": "build/index.d.ts", "keywords": [ diff --git a/src/apis/replicapool/tsconfig.json b/src/apis/searchconsole/tsconfig.json similarity index 100% rename from src/apis/replicapool/tsconfig.json rename to src/apis/searchconsole/tsconfig.json diff --git a/src/apis/searchconsole/v1.ts b/src/apis/searchconsole/v1.ts new file mode 100644 index 0000000000..3a435401fe --- /dev/null +++ b/src/apis/searchconsole/v1.ts @@ -0,0 +1,323 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace searchconsole_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; + } + + /** + * Google Search Console URL Testing Tools API + * + * Provides tools for running validation tests against single URLs + * + * @example + * const {google} = require('googleapis'); + * const searchconsole = google.searchconsole('v1'); + * + * @namespace searchconsole + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Searchconsole + */ + export class Searchconsole { + context: APIRequestContext; + urlTestingTools: Resource$Urltestingtools; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.urlTestingTools = new Resource$Urltestingtools(this.context); + } + } + + /** + * Blocked resource. + */ + export interface Schema$BlockedResource { + /** + * URL of the blocked resource. + */ + url?: string | null; + } + /** + * Describe image data. + */ + export interface Schema$Image { + /** + * Image data in format determined by the mime type. Currently, the format will always be "image/png", but this might change in the future. + */ + data?: string | null; + /** + * The mime-type of the image data. + */ + mimeType?: string | null; + } + /** + * Mobile-friendly issue. + */ + export interface Schema$MobileFriendlyIssue { + /** + * Rule violated. + */ + rule?: string | null; + } + /** + * Information about a resource with issue. + */ + export interface Schema$ResourceIssue { + /** + * Describes a blocked resource issue. + */ + blockedResource?: Schema$BlockedResource; + } + /** + * Mobile-friendly test request. + */ + export interface Schema$RunMobileFriendlyTestRequest { + /** + * Whether or not screenshot is requested. Default is false. + */ + requestScreenshot?: boolean | null; + /** + * URL for inspection. + */ + url?: string | null; + } + /** + * Mobile-friendly test response, including mobile-friendly issues and resource issues. + */ + export interface Schema$RunMobileFriendlyTestResponse { + /** + * Test verdict, whether the page is mobile friendly or not. + */ + mobileFriendliness?: string | null; + /** + * List of mobile-usability issues. + */ + mobileFriendlyIssues?: Schema$MobileFriendlyIssue[]; + /** + * Information about embedded resources issues. + */ + resourceIssues?: Schema$ResourceIssue[]; + /** + * Screenshot of the requested URL. + */ + screenshot?: Schema$Image; + /** + * Final state of the test, can be either complete or an error. + */ + testStatus?: Schema$TestStatus; + } + /** + * Final state of the test, including error details if necessary. + */ + export interface Schema$TestStatus { + /** + * Error details if applicable. + */ + details?: string | null; + /** + * Status of the test. + */ + status?: string | null; + } + + export class Resource$Urltestingtools { + context: APIRequestContext; + mobileFriendlyTest: Resource$Urltestingtools$Mobilefriendlytest; + constructor(context: APIRequestContext) { + this.context = context; + this.mobileFriendlyTest = new Resource$Urltestingtools$Mobilefriendlytest( + this.context + ); + } + } + + export class Resource$Urltestingtools$Mobilefriendlytest { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * searchconsole.urlTestingTools.mobileFriendlyTest.run + * @desc Runs Mobile-Friendly Test for a given URL. + * @alias searchconsole.urlTestingTools.mobileFriendlyTest.run + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {().RunMobileFriendlyTestRequest} params.requestBody Request 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$Urltestingtools$Mobilefriendlytest$Run, + options?: MethodOptions + ): GaxiosPromise; + run( + params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + run( + params: Params$Resource$Urltestingtools$Mobilefriendlytest$Run, + callback: BodyResponseCallback + ): void; + run( + callback: BodyResponseCallback + ): void; + run( + paramsOrCallback?: + | Params$Resource$Urltestingtools$Mobilefriendlytest$Run + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Urltestingtools$Mobilefriendlytest$Run; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Urltestingtools$Mobilefriendlytest$Run; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://searchconsole.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/urlTestingTools/mobileFriendlyTest:run' + ).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$Urltestingtools$Mobilefriendlytest$Run + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Request body metadata + */ + requestBody?: Schema$RunMobileFriendlyTestRequest; + } +} diff --git a/src/apis/servicebroker/webpack.config.js b/src/apis/searchconsole/webpack.config.js similarity index 96% rename from src/apis/servicebroker/webpack.config.js rename to src/apis/searchconsole/webpack.config.js index e50fca15ac..340379eb45 100644 --- a/src/apis/servicebroker/webpack.config.js +++ b/src/apis/searchconsole/webpack.config.js @@ -22,8 +22,8 @@ module.exports = { extensions: ['.ts', '.js', '.json'], }, output: { - library: 'Servicebroker', - filename: 'servicebroker.min.js', + library: 'Searchconsole', + filename: 'searchconsole.min.js', path: path.resolve(__dirname, 'dist'), }, node: { diff --git a/src/apis/secretmanager/README.md b/src/apis/secretmanager/README.md index 004c8f02f2..8630163eab 100644 --- a/src/apis/secretmanager/README.md +++ b/src/apis/secretmanager/README.md @@ -2,7 +2,7 @@ # secretmanager -> Stores, manages, and secures access to application secrets. +> Stores and manages access to application secrets. Provides convenience while improving security. ## Installation diff --git a/src/apis/secretmanager/index.ts b/src/apis/secretmanager/index.ts index bc3f003e9b..25bc8c200d 100644 --- a/src/apis/secretmanager/index.ts +++ b/src/apis/secretmanager/index.ts @@ -14,21 +14,33 @@ /*! THIS FILE IS AUTO-GENERATED */ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {secretmanager_v1} from './v1'; import {secretmanager_v1beta1} from './v1beta1'; export const VERSIONS = { + v1: secretmanager_v1.Secretmanager, v1beta1: secretmanager_v1beta1.Secretmanager, }; +export function secretmanager(version: 'v1'): secretmanager_v1.Secretmanager; +export function secretmanager( + options: secretmanager_v1.Options +): secretmanager_v1.Secretmanager; export function secretmanager( version: 'v1beta1' ): secretmanager_v1beta1.Secretmanager; export function secretmanager( options: secretmanager_v1beta1.Options ): secretmanager_v1beta1.Secretmanager; -export function secretmanager( +export function secretmanager< + T = secretmanager_v1.Secretmanager | secretmanager_v1beta1.Secretmanager +>( this: GoogleConfigurable, - versionOrOptions: 'v1beta1' | secretmanager_v1beta1.Options + versionOrOptions: + | 'v1' + | secretmanager_v1.Options + | 'v1beta1' + | secretmanager_v1beta1.Options ) { return getAPI('secretmanager', versionOrOptions, VERSIONS, this); } diff --git a/src/apis/secretmanager/v1.ts b/src/apis/secretmanager/v1.ts new file mode 100644 index 0000000000..9b65d19cbf --- /dev/null +++ b/src/apis/secretmanager/v1.ts @@ -0,0 +1,2032 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace secretmanager_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; + } + + /** + * Secret Manager API + * + * Stores API keys, passwords, certificates, and other sensitive data. Provides convenience while improving security. + * + * @example + * const {google} = require('googleapis'); + * const secretmanager = google.secretmanager('v1'); + * + * @namespace secretmanager + * @type {Function} + * @version v1 + * @variation v1 + * @param {object=} options Options for Secretmanager + */ + export class Secretmanager { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * Response message for SecretManagerService.AccessSecretVersion. + */ + export interface Schema$AccessSecretVersionResponse { + /** + * The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x. + */ + name?: string | null; + /** + * Secret payload + */ + payload?: Schema$SecretPayload; + } + /** + * Request message for SecretManagerService.AddSecretVersion. + */ + export interface Schema$AddSecretVersionRequest { + /** + * Required. The secret payload of the SecretVersion. + */ + payload?: Schema$SecretPayload; + } + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + */ + service?: string | null; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * A replication policy that replicates the Secret payload without any restrictions. + */ + export interface Schema$Automatic {} + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + */ + members?: string[] | null; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string | null; + } + /** + * Request message for SecretManagerService.DestroySecretVersion. + */ + export interface Schema$DestroySecretVersionRequest {} + /** + * Request message for SecretManagerService.DisableSecretVersion. + */ + export interface Schema$DisableSecretVersionRequest {} + /** + * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. + */ + export interface Schema$Empty {} + /** + * Request message for SecretManagerService.EnableSecretVersion. + */ + export interface Schema$EnableSecretVersionRequest {} + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + /** + * 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 | null; + } + /** + * Response message for SecretManagerService.ListSecrets. + */ + export interface Schema$ListSecretsResponse { + /** + * A token to retrieve the next page of results. Pass this value in ListSecretsRequest.page_token to retrieve the next page. + */ + nextPageToken?: string | null; + /** + * The list of Secrets sorted in reverse by create_time (newest first). + */ + secrets?: Schema$Secret[]; + /** + * The total number of Secrets. + */ + totalSize?: number | null; + } + /** + * Response message for SecretManagerService.ListSecretVersions. + */ + export interface Schema$ListSecretVersionsResponse { + /** + * A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page. + */ + nextPageToken?: string | null; + /** + * The total number of SecretVersions. + */ + totalSize?: number | null; + /** + * The list of SecretVersions sorted in reverse by create_time (newest first). + */ + versions?: Schema$SecretVersion[]; + } + /** + * 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 | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](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`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + */ + 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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + */ + version?: number | null; + } + /** + * Represents a Replica for this Secret. + */ + export interface Schema$Replica { + /** + * The canonical IDs of the location to replicate data. For example: `"us-east1"`. + */ + location?: string | null; + } + /** + * A policy that defines the replication configuration of data. + */ + export interface Schema$Replication { + /** + * The Secret will automatically be replicated without any restrictions. + */ + automatic?: Schema$Automatic; + /** + * The Secret will only be replicated into the locations specified. + */ + userManaged?: Schema$UserManaged; + } + /** + * A Secret is a logical secret whose value and versions can be accessed. A Secret is made up of zero or more SecretVersions that represent the secret data. + */ + export interface Schema$Secret { + /** + * Output only. The time at which the Secret was created. + */ + createTime?: string | null; + /** + * The labels assigned to this Secret. 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 must be between 0 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 assigned to a given resource. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The resource name of the Secret in the format `projects/x/secrets/x. + */ + name?: string | null; + /** + * Required. Immutable. The replication policy of the secret data attached to the Secret. The replication policy cannot be changed after the Secret has been created. + */ + replication?: Schema$Replication; + } + /** + * A secret payload resource in the Secret Manager API. This contains the sensitive secret data that is associated with a SecretVersion. + */ + export interface Schema$SecretPayload { + /** + * The secret data. Must be no larger than 64KiB. + */ + data?: string | null; + } + /** + * A secret version resource in the Secret Manager API. + */ + export interface Schema$SecretVersion { + /** + * Output only. The time at which the SecretVersion was created. + */ + createTime?: string | null; + /** + * Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. + */ + destroyTime?: string | null; + /** + * Output only. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. + */ + name?: string | null; + /** + * Output only. The current state of the SecretVersion. + */ + state?: string | null; + } + /** + * 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 | null; + } + /** + * 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[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * A replication policy that replicates the Secret payload into the locations specified in Secret.replication.user_managed.replicas + */ + export interface Schema$UserManaged { + /** + * Required. The list of Replicas for this Secret. Cannot be empty. + */ + replicas?: Schema$Replica[]; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + secrets: Resource$Projects$Secrets; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + this.secrets = new Resource$Projects$Secrets(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * secretmanager.projects.locations.get + * @desc Gets information about a location. + * @alias secretmanager.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://secretmanager.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); + } + } + + /** + * secretmanager.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias secretmanager.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://secretmanager.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$Secrets { + context: APIRequestContext; + versions: Resource$Projects$Secrets$Versions; + constructor(context: APIRequestContext) { + this.context = context; + this.versions = new Resource$Projects$Secrets$Versions(this.context); + } + + /** + * secretmanager.projects.secrets.addVersion + * @desc Creates a new SecretVersion containing secret data and attaches it to an existing Secret. + * @alias secretmanager.projects.secrets.addVersion + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/x/secrets/x`. + * @param {().AddSecretVersionRequest} params.requestBody Request 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 + */ + addVersion( + params?: Params$Resource$Projects$Secrets$Addversion, + options?: MethodOptions + ): GaxiosPromise; + addVersion( + params: Params$Resource$Projects$Secrets$Addversion, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addVersion( + params: Params$Resource$Projects$Secrets$Addversion, + callback: BodyResponseCallback + ): void; + addVersion(callback: BodyResponseCallback): void; + addVersion( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Addversion + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Addversion; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Addversion; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:addVersion').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.create + * @desc Creates a new Secret containing no SecretVersions. + * @alias secretmanager.projects.secrets.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The resource name of the project to associate with the Secret, in the format `projects/x`. + * @param {string=} params.secretId Required. This must be unique within the project. + * @param {().Secret} params.requestBody Request 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$Secrets$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Secrets$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Secrets$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.delete + * @desc Deletes a Secret. + * @alias secretmanager.projects.secrets.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the Secret to delete in the format `projects/x/secrets/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 + */ + delete( + params?: Params$Resource$Projects$Secrets$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Secrets$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Secrets$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.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); + } + } + + /** + * secretmanager.projects.secrets.get + * @desc Gets metadata for a given Secret. + * @alias secretmanager.projects.secrets.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the Secret, in the format `projects/x/secrets/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 + */ + get( + params?: Params$Resource$Projects$Secrets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Secrets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Secrets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.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); + } + } + + /** + * secretmanager.projects.secrets.getIamPolicy + * @desc Gets the access control policy for a secret. Returns empty policy if the secret exists and does not have a policy set. + * @alias secretmanager.projects.secrets.getIamPolicy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * @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$Secrets$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Secrets$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Secrets$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * secretmanager.projects.secrets.list + * @desc Lists Secrets. + * @alias secretmanager.projects.secrets.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + * @param {string=} params.pageToken Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token. + * @param {string} params.parent Required. The resource name of the project associated with the Secrets, 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$Secrets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Secrets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Secrets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/secrets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.patch + * @desc Updates metadata of an existing Secret. + * @alias secretmanager.projects.secrets.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Output only. The resource name of the Secret in the format `projects/x/secrets/x`. + * @param {string=} params.updateMask Required. Specifies the fields to be updated. + * @param {().Secret} params.requestBody Request 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$Secrets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Secrets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Secrets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.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); + } + } + + /** + * secretmanager.projects.secrets.setIamPolicy + * @desc Sets the access control policy on the specified secret. Replaces any existing policy. Permissions on SecretVersions are enforced according to the policy set on the associated Secret. + * @alias secretmanager.projects.secrets.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.requestBody Request 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$Secrets$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Secrets$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Secrets$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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); + } + } + + /** + * secretmanager.projects.secrets.testIamPermissions + * @desc Returns permissions that a caller has for the specified secret. If the secret does not exist, this call returns 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 secretmanager.projects.secrets.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.requestBody Request 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$Secrets$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Secrets$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Secrets$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+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$Secrets$Addversion + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the Secret to associate with the SecretVersion in the format `projects/x/secrets/x`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AddSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the project to associate with the Secret, in the format `projects/x`. + */ + parent?: string; + /** + * Required. This must be unique within the project. + */ + secretId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Secrets$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the Secret to delete in the format `projects/x/secrets/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the Secret, in the format `projects/x/secrets/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Getiampolicy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + 'options.requestedPolicyVersion'?: number; + /** + * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. + */ + resource?: string; + } + export interface Params$Resource$Projects$Secrets$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + */ + pageSize?: number; + /** + * Optional. Pagination token, returned earlier via ListSecretsResponse.next_page_token. + */ + pageToken?: string; + /** + * Required. The resource name of the project associated with the Secrets, in the format `projects/x`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Secrets$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Output only. The resource name of the Secret in the format `projects/x/secrets/x`. + */ + name?: string; + /** + * Required. Specifies the fields to be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Secret; + } + export interface Params$Resource$Projects$Secrets$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$Secrets$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$Secrets$Versions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * secretmanager.projects.secrets.versions.access + * @desc Accesses a SecretVersion. This call returns the secret data. `projects/x/secrets/x/versions/latest` is an alias to the `latest` SecretVersion. + * @alias secretmanager.projects.secrets.versions.access + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/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 + */ + access( + params?: Params$Resource$Projects$Secrets$Versions$Access, + options?: MethodOptions + ): GaxiosPromise; + access( + params: Params$Resource$Projects$Secrets$Versions$Access, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + access( + params: Params$Resource$Projects$Secrets$Versions$Access, + callback: BodyResponseCallback + ): void; + access( + callback: BodyResponseCallback + ): void; + access( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Access + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Access; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Access; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:access').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.destroy + * @desc Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data. + * @alias secretmanager.projects.secrets.versions.destroy + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion to destroy in the format `projects/x/secrets/x/versions/x`. + * @param {().DestroySecretVersionRequest} params.requestBody Request 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 + */ + destroy( + params?: Params$Resource$Projects$Secrets$Versions$Destroy, + options?: MethodOptions + ): GaxiosPromise; + destroy( + params: Params$Resource$Projects$Secrets$Versions$Destroy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + destroy( + params: Params$Resource$Projects$Secrets$Versions$Destroy, + callback: BodyResponseCallback + ): void; + destroy(callback: BodyResponseCallback): void; + destroy( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Destroy + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Destroy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Destroy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:destroy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.disable + * @desc Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED. + * @alias secretmanager.projects.secrets.versions.disable + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion to disable in the format `projects/x/secrets/x/versions/x`. + * @param {().DisableSecretVersionRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + disable( + params?: Params$Resource$Projects$Secrets$Versions$Disable, + options?: MethodOptions + ): GaxiosPromise; + disable( + params: Params$Resource$Projects$Secrets$Versions$Disable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + disable( + params: Params$Resource$Projects$Secrets$Versions$Disable, + callback: BodyResponseCallback + ): void; + disable(callback: BodyResponseCallback): void; + disable( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Disable + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Disable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Disable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:disable').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.enable + * @desc Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. + * @alias secretmanager.projects.secrets.versions.enable + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion to enable in the format `projects/x/secrets/x/versions/x`. + * @param {().EnableSecretVersionRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + enable( + params?: Params$Resource$Projects$Secrets$Versions$Enable, + options?: MethodOptions + ): GaxiosPromise; + enable( + params: Params$Resource$Projects$Secrets$Versions$Enable, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + enable( + params: Params$Resource$Projects$Secrets$Versions$Enable, + callback: BodyResponseCallback + ): void; + enable(callback: BodyResponseCallback): void; + enable( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Enable + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Enable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Enable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:enable').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * secretmanager.projects.secrets.versions.get + * @desc Gets metadata for a SecretVersion. `projects/x/secrets/x/versions/latest` is an alias to the `latest` SecretVersion. + * @alias secretmanager.projects.secrets.versions.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x`. `projects/x/secrets/x/versions/latest` is an alias to the `latest` SecretVersion. + * @param {object} [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$Secrets$Versions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Secrets$Versions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Secrets$Versions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.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); + } + } + + /** + * secretmanager.projects.secrets.versions.list + * @desc Lists SecretVersions. This call does not return secret data. + * @alias secretmanager.projects.secrets.versions.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + * @param {string=} params.pageToken Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][]. + * @param {string} params.parent Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/x/secrets/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$Secrets$Versions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Secrets$Versions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Secrets$Versions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Secrets$Versions$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Secrets$Versions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Secrets$Versions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://secretmanager.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/versions').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$Secrets$Versions$Access + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x`. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Versions$Destroy + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion to destroy in the format `projects/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DestroySecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Disable + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion to disable in the format `projects/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DisableSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Enable + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion to enable in the format `projects/x/secrets/x/versions/x`. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EnableSecretVersionRequest; + } + export interface Params$Resource$Projects$Secrets$Versions$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The resource name of the SecretVersion in the format `projects/x/secrets/x/versions/x`. `projects/x/secrets/x/versions/latest` is an alias to the `latest` SecretVersion. + */ + name?: string; + } + export interface Params$Resource$Projects$Secrets$Versions$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. + */ + pageSize?: number; + /** + * Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][]. + */ + pageToken?: string; + /** + * Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/x/secrets/x`. + */ + parent?: string; + } +} diff --git a/src/apis/secretmanager/v1beta1.ts b/src/apis/secretmanager/v1beta1.ts index 74f66e5fdf..8aa75d1101 100644 --- a/src/apis/secretmanager/v1beta1.ts +++ b/src/apis/secretmanager/v1beta1.ts @@ -89,7 +89,7 @@ export namespace secretmanager_v1beta1 { /** * Secret Manager API * - * Stores, manages, and secures access to application secrets. + * Stores API keys, passwords, certificates, and other sensitive data. Provides convenience while improving security. * * @example * const {google} = require('googleapis'); @@ -201,23 +201,23 @@ export namespace secretmanager_v1beta1 { */ export interface Schema$EnableSecretVersionRequest {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index b1c6e04ae0..ca44c323e8 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -209,23 +209,23 @@ export namespace securitycenter_v1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -305,6 +305,186 @@ export namespace securitycenter_v1 { */ state?: string | null; } + /** + * Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud Platform (GCP) resource. The Asset is a Cloud SCC resource that captures information about a single GCP resource. All modifications to an Asset are only within the context of Cloud SCC and don't affect the referenced GCP resource. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1Asset { + /** + * The time at which the asset was created in Cloud SCC. + */ + createTime?: string | null; + /** + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. + */ + iamPolicy?: Schema$GoogleCloudSecuritycenterV1p1beta1IamPolicy; + /** + * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}". + */ + name?: string | null; + /** + * Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. + */ + resourceProperties?: {[key: string]: any} | null; + /** + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. + */ + securityCenterProperties?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties; + /** + * User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. + */ + securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + /** + * The time at which the asset was last updated, added, or deleted in Cloud SCC. + */ + updateTime?: string | null; + } + /** + * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1Finding { + /** + * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" + */ + category?: string | null; + /** + * The time at which the finding was created in Cloud SCC. + */ + createTime?: string | null; + /** + * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. + */ + eventTime?: string | null; + /** + * The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. + */ + externalUri?: string | null; + /** + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" + */ + name?: string | null; + /** + * The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + */ + parent?: string | null; + /** + * For findings on Google Cloud Platform (GCP) resources, the full resource name of the GCP resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-GCP resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. + */ + resourceName?: string | null; + /** + * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. + */ + securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + /** + * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + */ + sourceProperties?: {[key: string]: any} | null; + /** + * The state of the finding. + */ + state?: string | null; + } + /** + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1IamPolicy { + /** + * The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1p1beta1/Policy for format details. + */ + policyBlob?: string | null; + } + /** + * Cloud SCC's Notification + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1NotificationMessage { + /** + * If it's a Finding based notification config, this field will be populated. + */ + finding?: Schema$GoogleCloudSecuritycenterV1p1beta1Finding; + /** + * Name of the notification config that generated current notification. + */ + notificationConfigName?: string | null; + /** + * If it's an asset based notification config, this field will be populated. + */ + temporalAsset?: Schema$GoogleCloudSecuritycenterV1p1beta1TemporalAsset; + } + /** + * Response of asset discovery run + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse { + /** + * The duration between asset discovery run start and end + */ + duration?: string | null; + /** + * The state of an asset discovery run. + */ + state?: string | null; + } + /** + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties { + /** + * The user defined display name for this resource. + */ + resourceDisplayName?: string | null; + /** + * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceName?: string | null; + /** + * Owners of the Google Cloud resource. + */ + resourceOwners?: string[] | null; + /** + * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceParent?: string | null; + /** + * The user defined display name for the parent of this resource. + */ + resourceParentDisplayName?: string | null; + /** + * The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceProject?: string | null; + /** + * The user defined display name for the project of this resource. + */ + resourceProjectDisplayName?: string | null; + /** + * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. + */ + resourceType?: string | null; + } + /** + * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks { + /** + * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + */ + marks?: {[key: string]: string} | null; + /** + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + */ + name?: string | null; + } + /** + * Wrapper over asset object that also captures the state change for the asset e.g. if it was a newly created asset vs updated or deleted asset. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1TemporalAsset { + /** + * Asset data that includes attributes, properties and marks about the asset. + */ + asset?: Schema$GoogleCloudSecuritycenterV1p1beta1Asset; + /** + * Represents if the asset was created/updated/deleted. + */ + changeType?: string | null; + } /** * Response of asset discovery run */ diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index 690ed12503..0972ba343a 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -138,7 +138,7 @@ export namespace securitycenter_v1beta1 { /** * User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. */ - securityMarks?: Schema$SecurityMarks; + securityMarks?: Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks; /** * The time at which the asset was last updated, added, or deleted in Cloud SCC. */ @@ -209,30 +209,48 @@ export namespace securitycenter_v1beta1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } + /** + * Request message for `GetIamPolicy` method. + */ + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + requestedPolicyVersion?: number | null; + } /** * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. */ - export interface Schema$Finding { + export interface Schema$GoogleCloudSecuritycenterV1beta1Finding { /** * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" */ @@ -264,7 +282,7 @@ export namespace securitycenter_v1beta1 { /** * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. */ - securityMarks?: Schema$SecurityMarks; + securityMarks?: Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks; /** * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. */ @@ -275,27 +293,139 @@ export namespace securitycenter_v1beta1 { state?: string | null; } /** - * Request message for `GetIamPolicy` method. + * Response of asset discovery run */ - export interface Schema$GetIamPolicyRequest { + export interface Schema$GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse { /** - * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + * The duration between asset discovery run start and end */ - options?: Schema$GetPolicyOptions; + duration?: string | null; + /** + * The state of an asset discovery run. + */ + state?: string | null; } /** - * Encapsulates settings provided to GetIamPolicy. + * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. */ - export interface Schema$GetPolicyOptions { + export interface Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks { /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) */ - requestedPolicyVersion?: number | null; + marks?: {[key: string]: string} | null; + /** + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + */ + name?: string | null; + } + /** + * Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud Platform (GCP) resource. The Asset is a Cloud SCC resource that captures information about a single GCP resource. All modifications to an Asset are only within the context of Cloud SCC and don't affect the referenced GCP resource. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1Asset { + /** + * The time at which the asset was created in Cloud SCC. + */ + createTime?: string | null; + /** + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. + */ + iamPolicy?: Schema$GoogleCloudSecuritycenterV1p1beta1IamPolicy; + /** + * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}". + */ + name?: string | null; + /** + * Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. + */ + resourceProperties?: {[key: string]: any} | null; + /** + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. + */ + securityCenterProperties?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties; + /** + * User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. + */ + securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + /** + * The time at which the asset was last updated, added, or deleted in Cloud SCC. + */ + updateTime?: string | null; + } + /** + * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1Finding { + /** + * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" + */ + category?: string | null; + /** + * The time at which the finding was created in Cloud SCC. + */ + createTime?: string | null; + /** + * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. + */ + eventTime?: string | null; + /** + * The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. + */ + externalUri?: string | null; + /** + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" + */ + name?: string | null; + /** + * The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + */ + parent?: string | null; + /** + * For findings on Google Cloud Platform (GCP) resources, the full resource name of the GCP resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-GCP resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. + */ + resourceName?: string | null; + /** + * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. + */ + securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + /** + * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + */ + sourceProperties?: {[key: string]: any} | null; + /** + * The state of the finding. + */ + state?: string | null; + } + /** + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1IamPolicy { + /** + * The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1p1beta1/Policy for format details. + */ + policyBlob?: string | null; + } + /** + * Cloud SCC's Notification + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1NotificationMessage { + /** + * If it's a Finding based notification config, this field will be populated. + */ + finding?: Schema$GoogleCloudSecuritycenterV1p1beta1Finding; + /** + * Name of the notification config that generated current notification. + */ + notificationConfigName?: string | null; + /** + * If it's an asset based notification config, this field will be populated. + */ + temporalAsset?: Schema$GoogleCloudSecuritycenterV1p1beta1TemporalAsset; } /** * Response of asset discovery run */ - export interface Schema$GoogleCloudSecuritycenterV1beta1RunAssetDiscoveryResponse { + export interface Schema$GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse { /** * The duration between asset discovery run start and end */ @@ -305,6 +435,69 @@ export namespace securitycenter_v1beta1 { */ state?: string | null; } + /** + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties { + /** + * The user defined display name for this resource. + */ + resourceDisplayName?: string | null; + /** + * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceName?: string | null; + /** + * Owners of the Google Cloud resource. + */ + resourceOwners?: string[] | null; + /** + * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceParent?: string | null; + /** + * The user defined display name for the parent of this resource. + */ + resourceParentDisplayName?: string | null; + /** + * The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceProject?: string | null; + /** + * The user defined display name for the project of this resource. + */ + resourceProjectDisplayName?: string | null; + /** + * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. + */ + resourceType?: string | null; + } + /** + * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks { + /** + * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + */ + marks?: {[key: string]: string} | null; + /** + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + */ + name?: string | null; + } + /** + * Wrapper over asset object that also captures the state change for the asset e.g. if it was a newly created asset vs updated or deleted asset. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1TemporalAsset { + /** + * Asset data that includes attributes, properties and marks about the asset. + */ + asset?: Schema$GoogleCloudSecuritycenterV1p1beta1Asset; + /** + * Represents if the asset was created/updated/deleted. + */ + changeType?: string | null; + } /** * Response of asset discovery run */ @@ -460,7 +653,7 @@ export namespace securitycenter_v1beta1 { /** * Findings matching the list request. */ - findings?: Schema$Finding[]; + findings?: Schema$GoogleCloudSecuritycenterV1beta1Finding[]; /** * Token to retrieve the next page of results, or empty if there are no more results. */ @@ -592,19 +785,6 @@ export namespace securitycenter_v1beta1 { */ resourceType?: string | null; } - /** - * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. - */ - export interface Schema$SecurityMarks { - /** - * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) - */ - marks?: {[key: string]: string} | null; - /** - * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". - */ - name?: string | null; - } /** * Request message for updating a finding's state. */ @@ -1135,7 +1315,7 @@ export namespace securitycenter_v1beta1 { * @param {string} params.name The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". * @param {string=} params.startTime The time at which the updated SecurityMarks take effect. * @param {string=} params.updateMask The FieldMask to use when updating the security marks resource. - * @param {().SecurityMarks} params.requestBody Request body data + * @param {().GoogleCloudSecuritycenterV1beta1SecurityMarks} params.requestBody Request 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 @@ -1143,28 +1323,46 @@ export namespace securitycenter_v1beta1 { updateSecurityMarks( params?: Params$Resource$Organizations$Assets$Updatesecuritymarks, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; updateSecurityMarks( params: Params$Resource$Organizations$Assets$Updatesecuritymarks, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + >, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > ): void; updateSecurityMarks( params: Params$Resource$Organizations$Assets$Updatesecuritymarks, - callback: BodyResponseCallback + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > ): void; updateSecurityMarks( - callback: BodyResponseCallback + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > ): void; updateSecurityMarks( paramsOrCallback?: | Params$Resource$Organizations$Assets$Updatesecuritymarks - | BodyResponseCallback, + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + >, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > + ): void | GaxiosPromise< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > { let params = (paramsOrCallback || {}) as Params$Resource$Organizations$Assets$Updatesecuritymarks; let options = (optionsOrCallback || {}) as MethodOptions; @@ -1196,9 +1394,14 @@ export namespace securitycenter_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + >(parameters); } } } @@ -1300,7 +1503,7 @@ export namespace securitycenter_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$SecurityMarks; + requestBody?: Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks; } export class Resource$Organizations$Operations { @@ -2339,7 +2542,7 @@ export namespace securitycenter_v1beta1 { * @param {object} params Parameters for request * @param {string=} params.findingId Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. * @param {string} params.parent Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". - * @param {().Finding} params.requestBody Request body data + * @param {().GoogleCloudSecuritycenterV1beta1Finding} params.requestBody Request 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 @@ -2347,24 +2550,38 @@ export namespace securitycenter_v1beta1 { create( params?: Params$Resource$Organizations$Sources$Findings$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( params: Params$Resource$Organizations$Sources$Findings$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > ): void; create( params: Params$Resource$Organizations$Sources$Findings$Create, - callback: BodyResponseCallback + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > + ): void; + create( + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > ): void; - create(callback: BodyResponseCallback): void; create( paramsOrCallback?: | Params$Resource$Organizations$Sources$Findings$Create - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > + ): void | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Organizations$Sources$Findings$Create; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2399,9 +2616,14 @@ export namespace securitycenter_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -2575,7 +2797,7 @@ export namespace securitycenter_v1beta1 { * @param {object} params Parameters for request * @param {string} params.name The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" * @param {string=} params.updateMask The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. - * @param {().Finding} params.requestBody Request body data + * @param {().GoogleCloudSecuritycenterV1beta1Finding} params.requestBody Request 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 @@ -2583,24 +2805,38 @@ export namespace securitycenter_v1beta1 { patch( params?: Params$Resource$Organizations$Sources$Findings$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( params: Params$Resource$Organizations$Sources$Findings$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > ): void; patch( params: Params$Resource$Organizations$Sources$Findings$Patch, - callback: BodyResponseCallback + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > + ): void; + patch( + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > ): void; - patch(callback: BodyResponseCallback): void; patch( paramsOrCallback?: | Params$Resource$Organizations$Sources$Findings$Patch - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > + ): void | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Organizations$Sources$Findings$Patch; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2632,9 +2868,14 @@ export namespace securitycenter_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -2654,24 +2895,38 @@ export namespace securitycenter_v1beta1 { setState( params?: Params$Resource$Organizations$Sources$Findings$Setstate, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; setState( params: Params$Resource$Organizations$Sources$Findings$Setstate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > ): void; setState( params: Params$Resource$Organizations$Sources$Findings$Setstate, - callback: BodyResponseCallback + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > + ): void; + setState( + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > ): void; - setState(callback: BodyResponseCallback): void; setState( paramsOrCallback?: | Params$Resource$Organizations$Sources$Findings$Setstate - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1Finding + > + ): void | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Organizations$Sources$Findings$Setstate; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2706,9 +2961,14 @@ export namespace securitycenter_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } @@ -2722,7 +2982,7 @@ export namespace securitycenter_v1beta1 { * @param {string} params.name The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". * @param {string=} params.startTime The time at which the updated SecurityMarks take effect. * @param {string=} params.updateMask The FieldMask to use when updating the security marks resource. - * @param {().SecurityMarks} params.requestBody Request body data + * @param {().GoogleCloudSecuritycenterV1beta1SecurityMarks} params.requestBody Request 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 @@ -2730,28 +2990,46 @@ export namespace securitycenter_v1beta1 { updateSecurityMarks( params?: Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; updateSecurityMarks( params: Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + >, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > ): void; updateSecurityMarks( params: Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks, - callback: BodyResponseCallback + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > ): void; updateSecurityMarks( - callback: BodyResponseCallback + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > ): void; updateSecurityMarks( paramsOrCallback?: | Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks - | BodyResponseCallback, + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + >, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > + ): void | GaxiosPromise< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + > { let params = (paramsOrCallback || {}) as Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks; let options = (optionsOrCallback || {}) as MethodOptions; @@ -2783,9 +3061,14 @@ export namespace securitycenter_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks + >(parameters); } } } @@ -2809,7 +3092,7 @@ export namespace securitycenter_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$Finding; + requestBody?: Schema$GoogleCloudSecuritycenterV1beta1Finding; } export interface Params$Resource$Organizations$Sources$Findings$Group extends StandardParameters { @@ -2883,7 +3166,7 @@ export namespace securitycenter_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$Finding; + requestBody?: Schema$GoogleCloudSecuritycenterV1beta1Finding; } export interface Params$Resource$Organizations$Sources$Findings$Setstate extends StandardParameters { @@ -2925,6 +3208,6 @@ export namespace securitycenter_v1beta1 { /** * Request body metadata */ - requestBody?: Schema$SecurityMarks; + requestBody?: Schema$GoogleCloudSecuritycenterV1beta1SecurityMarks; } } diff --git a/src/apis/securitycenter/v1p1alpha1.ts b/src/apis/securitycenter/v1p1alpha1.ts index d547632d47..aaca48e06f 100644 --- a/src/apis/securitycenter/v1p1alpha1.ts +++ b/src/apis/securitycenter/v1p1alpha1.ts @@ -132,6 +132,186 @@ export namespace securitycenter_v1p1alpha1 { */ state?: string | null; } + /** + * Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud Platform (GCP) resource. The Asset is a Cloud SCC resource that captures information about a single GCP resource. All modifications to an Asset are only within the context of Cloud SCC and don't affect the referenced GCP resource. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1Asset { + /** + * The time at which the asset was created in Cloud SCC. + */ + createTime?: string | null; + /** + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. + */ + iamPolicy?: Schema$GoogleCloudSecuritycenterV1p1beta1IamPolicy; + /** + * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}". + */ + name?: string | null; + /** + * Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. + */ + resourceProperties?: {[key: string]: any} | null; + /** + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. + */ + securityCenterProperties?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties; + /** + * User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. + */ + securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + /** + * The time at which the asset was last updated, added, or deleted in Cloud SCC. + */ + updateTime?: string | null; + } + /** + * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1Finding { + /** + * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" + */ + category?: string | null; + /** + * The time at which the finding was created in Cloud SCC. + */ + createTime?: string | null; + /** + * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. + */ + eventTime?: string | null; + /** + * The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. + */ + externalUri?: string | null; + /** + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" + */ + name?: string | null; + /** + * The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + */ + parent?: string | null; + /** + * For findings on Google Cloud Platform (GCP) resources, the full resource name of the GCP resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-GCP resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. + */ + resourceName?: string | null; + /** + * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. + */ + securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + /** + * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + */ + sourceProperties?: {[key: string]: any} | null; + /** + * The state of the finding. + */ + state?: string | null; + } + /** + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1IamPolicy { + /** + * The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1p1beta1/Policy for format details. + */ + policyBlob?: string | null; + } + /** + * Cloud SCC's Notification + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1NotificationMessage { + /** + * If it's a Finding based notification config, this field will be populated. + */ + finding?: Schema$GoogleCloudSecuritycenterV1p1beta1Finding; + /** + * Name of the notification config that generated current notification. + */ + notificationConfigName?: string | null; + /** + * If it's an asset based notification config, this field will be populated. + */ + temporalAsset?: Schema$GoogleCloudSecuritycenterV1p1beta1TemporalAsset; + } + /** + * Response of asset discovery run + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse { + /** + * The duration between asset discovery run start and end + */ + duration?: string | null; + /** + * The state of an asset discovery run. + */ + state?: string | null; + } + /** + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties { + /** + * The user defined display name for this resource. + */ + resourceDisplayName?: string | null; + /** + * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceName?: string | null; + /** + * Owners of the Google Cloud resource. + */ + resourceOwners?: string[] | null; + /** + * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceParent?: string | null; + /** + * The user defined display name for the parent of this resource. + */ + resourceParentDisplayName?: string | null; + /** + * The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceProject?: string | null; + /** + * The user defined display name for the project of this resource. + */ + resourceProjectDisplayName?: string | null; + /** + * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. + */ + resourceType?: string | null; + } + /** + * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks { + /** + * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + */ + marks?: {[key: string]: string} | null; + /** + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + */ + name?: string | null; + } + /** + * Wrapper over asset object that also captures the state change for the asset e.g. if it was a newly created asset vs updated or deleted asset. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1TemporalAsset { + /** + * Asset data that includes attributes, properties and marks about the asset. + */ + asset?: Schema$GoogleCloudSecuritycenterV1p1beta1Asset; + /** + * Represents if the asset was created/updated/deleted. + */ + changeType?: string | null; + } /** * Response of asset discovery run */ diff --git a/src/apis/securitycenter/v1p1beta1.ts b/src/apis/securitycenter/v1p1beta1.ts index 5c09042bd4..853a0b129d 100644 --- a/src/apis/securitycenter/v1p1beta1.ts +++ b/src/apis/securitycenter/v1p1beta1.ts @@ -115,10 +115,105 @@ export namespace securitycenter_v1p1beta1 { } } + /** + * The configuration used for Asset Discovery runs. + */ + export interface Schema$AssetDiscoveryConfig { + /** + * The mode to use for filtering asset discovery. + */ + inclusionMode?: string | null; + /** + * The project ids to use for filtering asset discovery. + */ + projectIds?: string[] | null; + } + /** + * Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. + */ + service?: string | null; + } + /** + * Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * Associates `members` with a `role`. + */ + export interface Schema$Binding { + /** + * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. + */ + condition?: Schema$Expr; + /** + * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. + */ + members?: string[] | null; + /** + * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string | null; + } /** * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. */ export interface Schema$Empty {} + /** + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + */ + title?: string | null; + } + /** + * Request message for `GetIamPolicy` method. + */ + export interface Schema$GetIamPolicyRequest { + /** + * OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. This field is only used by Cloud IAM. + */ + options?: Schema$GetPolicyOptions; + } + /** + * Encapsulates settings provided to GetIamPolicy. + */ + export interface Schema$GetPolicyOptions { + /** + * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. + */ + requestedPolicyVersion?: number | null; + } /** * Response of asset discovery run */ @@ -132,6 +227,186 @@ export namespace securitycenter_v1p1beta1 { */ state?: string | null; } + /** + * Cloud Security Command Center's (Cloud SCC) representation of a Google Cloud Platform (GCP) resource. The Asset is a Cloud SCC resource that captures information about a single GCP resource. All modifications to an Asset are only within the context of Cloud SCC and don't affect the referenced GCP resource. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1Asset { + /** + * The time at which the asset was created in Cloud SCC. + */ + createTime?: string | null; + /** + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. + */ + iamPolicy?: Schema$GoogleCloudSecuritycenterV1p1beta1IamPolicy; + /** + * The relative resource name of this asset. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/assets/{asset_id}". + */ + name?: string | null; + /** + * Resource managed properties. These properties are managed and defined by the GCP resource and cannot be modified by the user. + */ + resourceProperties?: {[key: string]: any} | null; + /** + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. + */ + securityCenterProperties?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties; + /** + * User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the asset. + */ + securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + /** + * The time at which the asset was last updated, added, or deleted in Cloud SCC. + */ + updateTime?: string | null; + } + /** + * Cloud Security Command Center (Cloud SCC) finding. A finding is a record of assessment data (security, risk, health or privacy) ingested into Cloud SCC for presentation, notification, analysis, policy testing, and enforcement. For example, an XSS vulnerability in an App Engine application is a finding. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1Finding { + /** + * The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" + */ + category?: string | null; + /** + * The time at which the finding was created in Cloud SCC. + */ + createTime?: string | null; + /** + * The time at which the event took place. For example, if the finding represents an open firewall it would capture the time the detector believes the firewall became open. The accuracy is determined by the detector. + */ + eventTime?: string | null; + /** + * The URI that, if available, points to a web page outside of Cloud SCC where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. + */ + externalUri?: string | null; + /** + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" + */ + name?: string | null; + /** + * The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}" + */ + parent?: string | null; + /** + * For findings on Google Cloud Platform (GCP) resources, the full resource name of the GCP resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-GCP resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. + */ + resourceName?: string | null; + /** + * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. + */ + securityMarks?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + /** + * Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. + */ + sourceProperties?: {[key: string]: any} | null; + /** + * The state of the finding. + */ + state?: string | null; + } + /** + * IAM Policy information associated with the GCP resource described by the Cloud SCC asset. This information is managed and defined by the GCP resource and cannot be modified by the user. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1IamPolicy { + /** + * The JSON representation of the Policy associated with the asset. See https://cloud.google.com/iam/reference/rest/v1p1beta1/Policy for format details. + */ + policyBlob?: string | null; + } + /** + * Cloud SCC's Notification + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1NotificationMessage { + /** + * If it's a Finding based notification config, this field will be populated. + */ + finding?: Schema$GoogleCloudSecuritycenterV1p1beta1Finding; + /** + * Name of the notification config that generated current notification. + */ + notificationConfigName?: string | null; + /** + * If it's an asset based notification config, this field will be populated. + */ + temporalAsset?: Schema$GoogleCloudSecuritycenterV1p1beta1TemporalAsset; + } + /** + * Response of asset discovery run + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1RunAssetDiscoveryResponse { + /** + * The duration between asset discovery run start and end + */ + duration?: string | null; + /** + * The state of an asset discovery run. + */ + state?: string | null; + } + /** + * Cloud SCC managed properties. These properties are managed by Cloud SCC and cannot be modified by the user. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityCenterProperties { + /** + * The user defined display name for this resource. + */ + resourceDisplayName?: string | null; + /** + * The full resource name of the GCP resource this asset represents. This field is immutable after create time. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceName?: string | null; + /** + * Owners of the Google Cloud resource. + */ + resourceOwners?: string[] | null; + /** + * The full resource name of the immediate parent of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceParent?: string | null; + /** + * The user defined display name for the parent of this resource. + */ + resourceParentDisplayName?: string | null; + /** + * The full resource name of the project the resource belongs to. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + resourceProject?: string | null; + /** + * The user defined display name for the project of this resource. + */ + resourceProjectDisplayName?: string | null; + /** + * The type of the GCP resource. Examples include: APPLICATION, PROJECT, and ORGANIZATION. This is a case insensitive field defined by Cloud SCC and/or the producer of the resource and is immutable after create time. + */ + resourceType?: string | null; + } + /** + * User specified security marks that are attached to the parent Cloud Security Command Center (Cloud SCC) resource. Security marks are scoped within a Cloud SCC organization -- they can be modified and viewed by all users who have proper permissions on the organization. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks { + /** + * Mutable user specified security marks belonging to the parent resource. Constraints are as follows: * Keys and values are treated as case insensitive * Keys must be between 1 - 256 characters (inclusive) * Keys must be letters, numbers, underscores, or dashes * Values have leading and trailing whitespace trimmed, remaining characters must be between 1 - 4096 characters (inclusive) + */ + marks?: {[key: string]: string} | null; + /** + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + */ + name?: string | null; + } + /** + * Wrapper over asset object that also captures the state change for the asset e.g. if it was a newly created asset vs updated or deleted asset. + */ + export interface Schema$GoogleCloudSecuritycenterV1p1beta1TemporalAsset { + /** + * Asset data that includes attributes, properties and marks about the asset. + */ + asset?: Schema$GoogleCloudSecuritycenterV1p1beta1Asset; + /** + * Represents if the asset was created/updated/deleted. + */ + changeType?: string | null; + } /** * Response of asset discovery run */ @@ -146,116 +421,2805 @@ export namespace securitycenter_v1p1beta1 { state?: string | null; } /** - * The response message for Operations.ListOperations. + * Request message for grouping by assets. */ - export interface Schema$ListOperationsResponse { + export interface Schema$GroupAssetsRequest { /** - * The standard List next-page token. + * When compare_duration is set, the GroupResult's "state_change" property is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at reference_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at reference_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and reference_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. If this field is set then `state_change` must be a specified field in `group_by`. + */ + compareDuration?: string | null; + /** + * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_name_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. + */ + filter?: string | null; + /** + * Required. Expression that defines what assets fields to use for grouping. The string value should follow SQL syntax: comma separated list of fields. For example: "security_center_properties.resource_project,security_center_properties.project". The following fields are supported when compare_duration is not set: * security_center_properties.resource_project * security_center_properties.resource_project_display_name * security_center_properties.resource_type * security_center_properties.resource_parent * security_center_properties.resource_parent_display_name The following fields are supported when compare_duration is set: * security_center_properties.resource_type * security_center_properties.resource_project_display_name * security_center_properties.resource_parent_display_name + */ + groupBy?: string | null; + /** + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + */ + pageSize?: number | null; + /** + * The value returned by the last `GroupAssetsResponse`; indicates that this is a continuation of a prior `GroupAssets` call, and that the system should return the next page of data. + */ + pageToken?: string | null; + /** + * Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. + */ + readTime?: string | null; + } + /** + * Response message for grouping by assets. + */ + export interface Schema$GroupAssetsResponse { + /** + * Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. + */ + groupByResults?: Schema$GroupResult[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results. */ nextPageToken?: string | null; /** - * A list of operations that matches the specified filter in the request. + * Time used for executing the groupBy request. */ - operations?: Schema$Operation[]; + readTime?: string | null; + /** + * The total number of results matching the query. + */ + totalSize?: number | null; } /** - * This resource represents a long-running operation that is the result of a network API call. + * Request message for grouping by findings. */ - export interface Schema$Operation { + export interface Schema$GroupFindingsRequest { /** - * 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. + * When compare_duration is set, the GroupResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. If this field is set then `state_change` must be a specified field in `group_by`. */ - done?: boolean | null; + compareDuration?: string | null; /** - * The error result of the operation in case of failure or cancellation. + * Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: * name: `=` * parent: `=`, `:` * resource_name: `=`, `:` * state: `=`, `:` * category: `=`, `:` * external_uri: `=`, `:` * event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "event_time = \"2019-06-10T16:07:18-07:00\"" "event_time = 1560208038000" * security_marks.marks: `=`, `:` * source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. */ - error?: Schema$Status; + filter?: string | null; /** - * 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. + * Required. Expression that defines what assets fields to use for grouping (including `state_change`). The string value should follow SQL syntax: comma separated list of fields. For example: "parent,resource_name". The following fields are supported: * resource_name * category * state * parent The following fields are supported when compare_duration is set: * state_change */ - metadata?: {[key: string]: any} | null; + groupBy?: string | null; /** - * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. */ - name?: string | null; + pageSize?: number | null; /** - * 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 value returned by the last `GroupFindingsResponse`; indicates that this is a continuation of a prior `GroupFindings` call, and that the system should return the next page of data. */ - response?: {[key: string]: any} | null; + pageToken?: string | null; + /** + * Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. + */ + readTime?: string | null; } /** - * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + * Response message for group by findings. */ - export interface Schema$Status { + export interface Schema$GroupFindingsResponse { /** - * The status code, which should be an enum value of google.rpc.Code. + * Group results. There exists an element for each existing unique combination of property/values. The element contains a count for the number of times those specific property/values appear. */ - code?: number | null; + groupByResults?: Schema$GroupResult[]; /** - * A list of messages that carry the error details. There is a common set of message types for APIs to use. + * Token to retrieve the next page of results, or empty if there are no more results. */ - details?: Array<{[key: string]: any}> | null; + nextPageToken?: string | null; /** - * 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. + * Time used for executing the groupBy request. + */ + readTime?: string | null; + /** + * The total number of results matching the query. + */ + totalSize?: number | null; + } + /** + * Result containing the properties and count of a groupBy request. + */ + export interface Schema$GroupResult { + /** + * Total count of resources for the given properties. + */ + count?: string | null; + /** + * Properties matching the groupBy fields in the request. + */ + properties?: {[key: string]: any} | null; + } + /** + * Response message for listing assets. + */ + export interface Schema$ListAssetsResponse { + /** + * Assets matching the list request. + */ + listAssetsResults?: Schema$ListAssetsResult[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results. + */ + nextPageToken?: string | null; + /** + * Time used for executing the list request. + */ + readTime?: string | null; + /** + * The total number of assets matching the query. + */ + totalSize?: number | null; + } + /** + * Result containing the Asset and its State. + */ + export interface Schema$ListAssetsResult { + /** + * Asset matching the search request. + */ + asset?: Schema$GoogleCloudSecuritycenterV1p1beta1Asset; + /** + * State change of the asset between the points in time. + */ + stateChange?: string | null; + } + /** + * Response message for listing findings. + */ + export interface Schema$ListFindingsResponse { + /** + * Findings matching the list request. + */ + listFindingsResults?: Schema$ListFindingsResult[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results. + */ + nextPageToken?: string | null; + /** + * Time used for executing the list request. + */ + readTime?: string | null; + /** + * The total number of findings matching the query. + */ + totalSize?: number | null; + } + /** + * Result containing the Finding and its StateChange. + */ + export interface Schema$ListFindingsResult { + /** + * Finding matching the search request. + */ + finding?: Schema$GoogleCloudSecuritycenterV1p1beta1Finding; + /** + * Output only. Resource that is associated with this finding. + */ + resource?: Schema$Resource; + /** + * State change of the finding between the points in time. + */ + stateChange?: string | null; + } + /** + * Response message for listing notification configs. + */ + export interface Schema$ListNotificationConfigsResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more results. + */ + nextPageToken?: string | null; + /** + * Notification configs belonging to the requested parent. + */ + notificationConfigs?: Schema$NotificationConfig[]; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * Response message for listing sources. + */ + export interface Schema$ListSourcesResponse { + /** + * Token to retrieve the next page of results, or empty if there are no more results. + */ + nextPageToken?: string | null; + /** + * Sources belonging to the requested parent. + */ + sources?: Schema$Source[]; + } + /** + * Cloud Security Command Center (Cloud SCC) notification configs. A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc. + */ + export interface Schema$NotificationConfig { + /** + * The description of the notification config (max of 1024 characters). + */ + description?: string | null; + /** + * The type of events the config is for, e.g. FINDING. + */ + eventType?: string | null; + /** + * The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket". + */ + name?: string | null; + /** + * The PubSub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". + */ + pubsubTopic?: string | null; + /** + * Output only. The service account that needs "pubsub.topics.publish" permission to publish to the PubSub topic. + */ + serviceAccount?: string | null; + /** + * The config for triggering streaming-based notifications. + */ + streamingConfig?: Schema$StreamingConfig; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * 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} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * User specified settings that are attached to the Cloud Security Command Center (Cloud SCC) organization. + */ + export interface Schema$OrganizationSettings { + /** + * The configuration used for Asset Discovery runs. + */ + assetDiscoveryConfig?: Schema$AssetDiscoveryConfig; + /** + * A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur. + */ + enableAssetDiscovery?: boolean | null; + /** + * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". + */ + name?: string | null; + } + /** + * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](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`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. + */ + 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. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. + */ + etag?: string | null; + /** + * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. + */ + version?: number | null; + } + /** + * Information related to the Google Cloud Platform (GCP) resource that is associated with this finding. + */ + export interface Schema$Resource { + /** + * The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name + */ + name?: string | null; + /** + * The human readable name of resource's parent. + */ + parentDisplayName?: string | null; + /** + * The full resource name of resource's parent. + */ + parentName?: string | null; + /** + * The human readable name of project that the resource belongs to. + */ + projectDisplayName?: string | null; + /** + * The full resource name of project that the resource belongs to. + */ + projectName?: string | null; + } + /** + * Request message for running asset discovery for an organization. + */ + export interface Schema$RunAssetDiscoveryRequest {} + /** + * Request message for updating a finding's state. + */ + export interface Schema$SetFindingStateRequest { + /** + * Required. The time at which the updated state takes effect. + */ + startTime?: string | null; + /** + * Required. The desired State of the finding. + */ + state?: string | null; + } + /** + * 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 | null; + } + /** + * Cloud Security Command Center's (Cloud SCC) finding source. A finding source is an entity or a mechanism that can produce a finding. A source is like a container of findings that come from the same scanner, logger, monitor, etc. + */ + export interface Schema$Source { + /** + * The description of the source (max of 1024 characters). Example: "Cloud Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated/insecure libraries." + */ + description?: string | null; + /** + * The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). + */ + displayName?: string | null; + /** + * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + */ + name?: string | null; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * 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}> | null; + /** + * 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 | null; + } + /** + * The config for streaming-based notifications, which send each event as soon as it is detected. + */ + export interface Schema$StreamingConfig { + /** + * Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form `<field> <operator> <value>` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. + */ + filter?: string | null; + } + /** + * 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[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + + export class Resource$Organizations { + context: APIRequestContext; + assets: Resource$Organizations$Assets; + notificationConfigs: Resource$Organizations$Notificationconfigs; + operations: Resource$Organizations$Operations; + sources: Resource$Organizations$Sources; + constructor(context: APIRequestContext) { + this.context = context; + this.assets = new Resource$Organizations$Assets(this.context); + this.notificationConfigs = new Resource$Organizations$Notificationconfigs( + this.context + ); + this.operations = new Resource$Organizations$Operations(this.context); + this.sources = new Resource$Organizations$Sources(this.context); + } + + /** + * securitycenter.organizations.getOrganizationSettings + * @desc Gets the settings for an organization. + * @alias securitycenter.organizations.getOrganizationSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + getOrganizationSettings( + params?: Params$Resource$Organizations$Getorganizationsettings, + options?: MethodOptions + ): GaxiosPromise; + getOrganizationSettings( + params: Params$Resource$Organizations$Getorganizationsettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getOrganizationSettings( + params: Params$Resource$Organizations$Getorganizationsettings, + callback: BodyResponseCallback + ): void; + getOrganizationSettings( + callback: BodyResponseCallback + ): void; + getOrganizationSettings( + paramsOrCallback?: + | Params$Resource$Organizations$Getorganizationsettings + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Getorganizationsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Getorganizationsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.updateOrganizationSettings + * @desc Updates an organization's settings. + * @alias securitycenter.organizations.updateOrganizationSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". + * @param {string=} params.updateMask The FieldMask to use when updating the settings resource. If empty all mutable fields will be updated. + * @param {().OrganizationSettings} params.requestBody Request 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 + */ + updateOrganizationSettings( + params?: Params$Resource$Organizations$Updateorganizationsettings, + options?: MethodOptions + ): GaxiosPromise; + updateOrganizationSettings( + params: Params$Resource$Organizations$Updateorganizationsettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateOrganizationSettings( + params: Params$Resource$Organizations$Updateorganizationsettings, + callback: BodyResponseCallback + ): void; + updateOrganizationSettings( + callback: BodyResponseCallback + ): void; + updateOrganizationSettings( + paramsOrCallback?: + | Params$Resource$Organizations$Updateorganizationsettings + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Updateorganizationsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Updateorganizationsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+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$Getorganizationsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the organization to get organization settings for. Its format is "organizations/[organization_id]/organizationSettings". + */ + name?: string; + } + export interface Params$Resource$Organizations$Updateorganizationsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". + */ + name?: string; + /** + * The FieldMask to use when updating the settings resource. If empty all mutable fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$OrganizationSettings; + } + + export class Resource$Organizations$Assets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * securitycenter.organizations.assets.group + * @desc Filters an organization's assets and groups them by their specified properties. + * @alias securitycenter.organizations.assets.group + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]". + * @param {().GroupAssetsRequest} params.requestBody Request 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 + */ + group( + params?: Params$Resource$Organizations$Assets$Group, + options?: MethodOptions + ): GaxiosPromise; + group( + params: Params$Resource$Organizations$Assets$Group, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + group( + params: Params$Resource$Organizations$Assets$Group, + callback: BodyResponseCallback + ): void; + group(callback: BodyResponseCallback): void; + group( + paramsOrCallback?: + | Params$Resource$Organizations$Assets$Group + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Assets$Group; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Assets$Group; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/assets:group').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.assets.list + * @desc Lists an organization's assets. + * @alias securitycenter.organizations.assets.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.compareDuration When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. + * @param {string=} params.fieldMask Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. + * @param {string=} params.filter Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. + * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type + * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + * @param {string=} params.pageToken The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data. + * @param {string} params.parent Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]". + * @param {string=} params.readTime Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. + * @param {object} [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$Assets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Assets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Assets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Assets$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Assets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Assets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/assets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.assets.runDiscovery + * @desc Runs asset discovery. The discovery is tracked with a long-running operation. // This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error. + * @alias securitycenter.organizations.assets.runDiscovery + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". + * @param {().RunAssetDiscoveryRequest} params.requestBody Request 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 + */ + runDiscovery( + params?: Params$Resource$Organizations$Assets$Rundiscovery, + options?: MethodOptions + ): GaxiosPromise; + runDiscovery( + params: Params$Resource$Organizations$Assets$Rundiscovery, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + runDiscovery( + params: Params$Resource$Organizations$Assets$Rundiscovery, + callback: BodyResponseCallback + ): void; + runDiscovery(callback: BodyResponseCallback): void; + runDiscovery( + paramsOrCallback?: + | Params$Resource$Organizations$Assets$Rundiscovery + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Assets$Rundiscovery; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Assets$Rundiscovery; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/assets:runDiscovery').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.assets.updateSecurityMarks + * @desc Updates security marks. + * @alias securitycenter.organizations.assets.updateSecurityMarks + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + * @param {string=} params.startTime The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. + * @param {string=} params.updateMask The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.". + * @param {().GoogleCloudSecuritycenterV1p1beta1SecurityMarks} params.requestBody Request 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 + */ + updateSecurityMarks( + params?: Params$Resource$Organizations$Assets$Updatesecuritymarks, + options?: MethodOptions + ): GaxiosPromise; + updateSecurityMarks( + params: Params$Resource$Organizations$Assets$Updatesecuritymarks, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > + ): void; + updateSecurityMarks( + params: Params$Resource$Organizations$Assets$Updatesecuritymarks, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > + ): void; + updateSecurityMarks( + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > + ): void; + updateSecurityMarks( + paramsOrCallback?: + | Params$Resource$Organizations$Assets$Updatesecuritymarks + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > + ): void | GaxiosPromise< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Assets$Updatesecuritymarks; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Assets$Updatesecuritymarks; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >(parameters, callback); + } else { + return createAPIRequest< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >(parameters); + } + } + } + + export interface Params$Resource$Organizations$Assets$Group + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the organization to groupBy. Its format is "organizations/[organization_id]". + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GroupAssetsRequest; + } + export interface Params$Resource$Organizations$Assets$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * When compare_duration is set, the ListAssetsResult's "state_change" attribute is updated to indicate whether the asset was added, removed, or remained present during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence of the asset at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the asset is removed and re-created again. Possible "state_change" values when compare_duration is specified: * "ADDED": indicates that the asset was not present at the start of compare_duration, but present at read_time. * "REMOVED": indicates that the asset was present at the start of compare_duration, but not present at read_time. * "ACTIVE": indicates that the asset was present at both the start and the end of the time period defined by compare_duration and read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all assets present at read_time. + */ + compareDuration?: string; + /** + * Optional. A field mask to specify the ListAssetsResult fields to be listed in the response. An empty field mask will list all fields. + */ + fieldMask?: string; + /** + * Expression that defines the filter to apply across assets. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the Asset resource. Examples include: * name * security_center_properties.resource_name * resource_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following are the allowed field and operator combinations: * name: `=` * update_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "update_time = \"2019-06-10T16:07:18-07:00\"" "update_time = 1560208038000" * create_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "create_time = \"2019-06-10T16:07:18-07:00\"" "create_time = 1560208038000" * iam_policy.policy_blob: `=`, `:` * resource_properties: `=`, `:`, `>`, `<`, `>=`, `<=` * security_marks.marks: `=`, `:` * security_center_properties.resource_name: `=`, `:` * security_center_properties.resource_display_name: `=`, `:` * security_center_properties.resource_type: `=`, `:` * security_center_properties.resource_parent: `=`, `:` * security_center_properties.resource_parent_display_name: `=`, `:` * security_center_properties.resource_project: `=`, `:` * security_center_properties.resource_project_display_name: `=`, `:` * security_center_properties.resource_owners: `=`, `:` For example, `resource_properties.size = 100` is a valid filter string. + */ + filter?: string; + /** + * Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,resource_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,resource_properties.a_property" and " name desc , resource_properties.a_property " are equivalent. The following fields are supported: name update_time resource_properties security_marks.marks security_center_properties.resource_name security_center_properties.resource_display_name security_center_properties.resource_parent security_center_properties.resource_parent_display_name security_center_properties.resource_project security_center_properties.resource_project_display_name security_center_properties.resource_type + */ + orderBy?: string; + /** + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + */ + pageSize?: number; + /** + * The value returned by the last `ListAssetsResponse`; indicates that this is a continuation of a prior `ListAssets` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. Name of the organization assets should belong to. Its format is "organizations/[organization_id]". + */ + parent?: string; + /** + * Time used as a reference point when filtering assets. The filter is limited to assets existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. + */ + readTime?: string; + } + export interface Params$Resource$Organizations$Assets$Rundiscovery + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the organization to run asset discovery for. Its format is "organizations/[organization_id]". + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RunAssetDiscoveryRequest; + } + export interface Params$Resource$Organizations$Assets$Updatesecuritymarks + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + */ + name?: string; + /** + * The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. + */ + startTime?: string; + /** + * The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.". + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; + } + + export class Resource$Organizations$Notificationconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * securitycenter.organizations.notificationConfigs.create + * @desc Creates a notification config. + * @alias securitycenter.organizations.notificationConfigs.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.configId Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only. + * @param {string} params.parent Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]". + * @param {().NotificationConfig} params.requestBody Request 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$Organizations$Notificationconfigs$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Notificationconfigs$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Notificationconfigs$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Notificationconfigs$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Notificationconfigs$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Notificationconfigs$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/notificationConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.notificationConfigs.delete + * @desc Deletes a notification config. + * @alias securitycenter.organizations.notificationConfigs.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_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$Organizations$Notificationconfigs$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Notificationconfigs$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Notificationconfigs$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Notificationconfigs$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Notificationconfigs$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Notificationconfigs$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.notificationConfigs.get + * @desc Gets a notification config. + * @alias securitycenter.organizations.notificationConfigs.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_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$Organizations$Notificationconfigs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Notificationconfigs$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Notificationconfigs$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Notificationconfigs$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Notificationconfigs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Notificationconfigs$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.notificationConfigs.list + * @desc Lists notification configs. + * @alias securitycenter.organizations.notificationConfigs.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + * @param {string=} params.pageToken The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data. + * @param {string} params.parent Required. Name of the organization to list notification configs. Its format is "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$Notificationconfigs$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Notificationconfigs$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Notificationconfigs$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Notificationconfigs$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Notificationconfigs$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Notificationconfigs$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/notificationConfigs').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * securitycenter.organizations.notificationConfigs.patch + * @desc Updates a notification config. + * @alias securitycenter.organizations.notificationConfigs.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket". + * @param {string=} params.updateMask The FieldMask to use when updating the notification config. If empty all mutable fields will be updated. + * @param {().NotificationConfig} params.requestBody Request 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$Organizations$Notificationconfigs$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Notificationconfigs$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Notificationconfigs$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizations$Notificationconfigs$Patch + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Notificationconfigs$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Notificationconfigs$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+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$Notificationconfigs$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Unique identifier provided by the client within the parent scope. It must be between 1 and 128 characters, and contains alphanumeric characters, underscores or hyphens only. + */ + configId?: string; + /** + * Required. Resource name of the new notification config's parent. Its format is "organizations/[organization_id]". + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NotificationConfig; + } + export interface Params$Resource$Organizations$Notificationconfigs$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the notification config to delete. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]". + */ + name?: string; + } + export interface Params$Resource$Organizations$Notificationconfigs$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Name of the notification config to get. Its format is "organizations/[organization_id]/notificationConfigs/[config_id]". + */ + name?: string; + } + export interface Params$Resource$Organizations$Notificationconfigs$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + */ + pageSize?: number; + /** + * The value returned by the last `ListNotificationConfigsResponse`; indicates that this is a continuation of a prior `ListNotificationConfigs` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. Name of the organization to list notification configs. Its format is "organizations/[organization_id]". + */ + parent?: string; + } + export interface Params$Resource$Organizations$Notificationconfigs$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket". + */ + name?: string; + /** + * The FieldMask to use when updating the notification config. If empty all mutable fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NotificationConfig; + } + + export class Resource$Organizations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * securitycenter.organizations.operations.cancel + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @alias securitycenter.organizations.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel( + params?: Params$Resource$Organizations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Organizations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Organizations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.operations.delete + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @alias securitycenter.organizations.operations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be deleted. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Organizations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Organizations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Organizations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.operations.get + * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. + * @alias securitycenter.organizations.operations.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + get( + params?: Params$Resource$Organizations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$Get + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.operations.list + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @alias securitycenter.organizations.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Organizations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Organizations$Operations$Cancel + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + } + export interface Params$Resource$Organizations$Operations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Organizations$Operations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Organizations$Operations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Organizations$Sources { + context: APIRequestContext; + findings: Resource$Organizations$Sources$Findings; + constructor(context: APIRequestContext) { + this.context = context; + this.findings = new Resource$Organizations$Sources$Findings(this.context); + } + + /** + * securitycenter.organizations.sources.create + * @desc Creates a source. + * @alias securitycenter.organizations.sources.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". + * @param {().Source} params.requestBody Request 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$Organizations$Sources$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Sources$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Organizations$Sources$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$Create + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/sources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.sources.get + * @desc Gets a source. + * @alias securitycenter.organizations.sources.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_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$Organizations$Sources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Organizations$Sources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Organizations$Sources$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.sources.getIamPolicy + * @desc Gets the access control policy on the specified Source. + * @alias securitycenter.organizations.sources.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.requestBody Request 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$Organizations$Sources$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Organizations$Sources$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Organizations$Sources$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$Getiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+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); + } + } + + /** + * securitycenter.organizations.sources.list + * @desc Lists all sources belonging to an organization. + * @alias securitycenter.organizations.sources.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + * @param {string=} params.pageToken The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data. + * @param {string} params.parent Required. Resource name of the parent of sources to list. Its format should be "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$Sources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Sources$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Organizations$Sources$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/sources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.sources.patch + * @desc Updates a source. + * @alias securitycenter.organizations.sources.patch + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + * @param {string=} params.updateMask The FieldMask to use when updating the source resource. If empty all mutable fields will be updated. + * @param {().Source} params.requestBody Request 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$Organizations$Sources$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Sources$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Organizations$Sources$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$Patch + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * securitycenter.organizations.sources.setIamPolicy + * @desc Sets the access control policy on the specified Source. + * @alias securitycenter.organizations.sources.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.requestBody Request 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$Organizations$Sources$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Organizations$Sources$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Organizations$Sources$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$Setiampolicy + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+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); + } + } + + /** + * securitycenter.organizations.sources.testIamPermissions + * @desc Returns the permissions that a caller has on the specified source. + * @alias securitycenter.organizations.sources.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.requestBody Request 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$Organizations$Sources$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Organizations$Sources$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Organizations$Sources$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$Testiampermissions + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1p1beta1/{+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$Organizations$Sources$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Resource name of the new source's parent. Its format should be "organizations/[organization_id]". + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Source; + } + export interface Params$Resource$Organizations$Sources$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Relative resource name of the source. Its format is "organizations/[organization_id]/source/[source_id]". + */ + name?: string; + } + export interface Params$Resource$Organizations$Sources$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$Organizations$Sources$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + */ + pageSize?: number; + /** + * The value returned by the last `ListSourcesResponse`; indicates that this is a continuation of a prior `ListSources` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. Resource name of the parent of sources to list. Its format should be "organizations/[organization_id]". + */ + parent?: string; + } + export interface Params$Resource$Organizations$Sources$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" + */ + name?: string; + /** + * The FieldMask to use when updating the source resource. If empty all mutable fields will be updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Source; + } + export interface Params$Resource$Organizations$Sources$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$Organizations$Sources$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$Organizations$Sources$Findings { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * securitycenter.organizations.sources.findings.create + * @desc Creates a finding. The corresponding source must exist for finding creation to succeed. + * @alias securitycenter.organizations.sources.findings.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.findingId Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. + * @param {string} params.parent Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". + * @param {().GoogleCloudSecuritycenterV1p1beta1Finding} params.requestBody Request 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$Organizations$Sources$Findings$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Organizations$Sources$Findings$Create, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > + ): void; + create( + params: Params$Resource$Organizations$Sources$Findings$Create, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > + ): void; + create( + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > + ): void; + create( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$Findings$Create + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$Findings$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$Findings$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/findings').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >(parameters); + } + } + + /** + * securitycenter.organizations.sources.findings.group + * @desc Filters an organization or source's findings and groups them by their specified properties. To group across all sources provide a `-` as the source id. Example: /v1p1beta1/organizations/{organization_id}/sources/-/findings + * @alias securitycenter.organizations.sources.findings.group + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/- + * @param {().GroupFindingsRequest} params.requestBody Request 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 */ - message?: string | null; - } + group( + params?: Params$Resource$Organizations$Sources$Findings$Group, + options?: MethodOptions + ): GaxiosPromise; + group( + params: Params$Resource$Organizations$Sources$Findings$Group, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + group( + params: Params$Resource$Organizations$Sources$Findings$Group, + callback: BodyResponseCallback + ): void; + group(callback: BodyResponseCallback): void; + group( + paramsOrCallback?: + | Params$Resource$Organizations$Sources$Findings$Group + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Organizations$Sources$Findings$Group; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Organizations { - context: APIRequestContext; - operations: Resource$Organizations$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = new Resource$Organizations$Operations(this.context); - } - } + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Organizations$Sources$Findings$Group; + options = {}; + } - export class Resource$Organizations$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://securitycenter.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1p1beta1/{+parent}/findings:group').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } } /** - * securitycenter.organizations.operations.cancel - * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. - * @alias securitycenter.organizations.operations.cancel + * securitycenter.organizations.sources.findings.list + * @desc Lists an organization or source's findings. To list across all sources provide a `-` as the source id. Example: /v1p1beta1/organizations/{organization_id}/sources/-/findings + * @alias securitycenter.organizations.sources.findings.list * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the operation resource to be cancelled. + * @param {string=} params.compareDuration When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. + * @param {string=} params.fieldMask Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. + * @param {string=} params.filter Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "event_time = \"2019-06-10T16:07:18-07:00\"" "event_time = 1560208038000" security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. + * @param {string=} params.orderBy Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks + * @param {integer=} params.pageSize The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + * @param {string=} params.pageToken The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data. + * @param {string} params.parent Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/- + * @param {string=} params.readTime Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - cancel( - params?: Params$Resource$Organizations$Operations$Cancel, + list( + params?: Params$Resource$Organizations$Sources$Findings$List, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Organizations$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + list( + params: Params$Resource$Organizations$Sources$Findings$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Organizations$Operations$Cancel, - callback: BodyResponseCallback + list( + params: Params$Resource$Organizations$Sources$Findings$List, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Organizations$Operations$Cancel - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Organizations$Sources$Findings$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Operations$Cancel; + {}) as Params$Resource$Organizations$Sources$Findings$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Operations$Cancel; + params = {} as Params$Resource$Organizations$Sources$Findings$List; options = {}; } @@ -269,66 +3233,88 @@ export namespace securitycenter_v1p1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1p1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1p1beta1/{+parent}/findings').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * securitycenter.organizations.operations.delete - * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - * @alias securitycenter.organizations.operations.delete + * securitycenter.organizations.sources.findings.patch + * @desc Creates or updates a finding. The corresponding source must exist for a finding creation to succeed. + * @alias securitycenter.organizations.sources.findings.patch * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the operation resource to be deleted. + * @param {string} params.name The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" + * @param {string=} params.updateMask The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using "source_properties." in the field mask. + * @param {().GoogleCloudSecuritycenterV1p1beta1Finding} params.requestBody Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ - delete( - params?: Params$Resource$Organizations$Operations$Delete, + patch( + params?: Params$Resource$Organizations$Sources$Findings$Patch, options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Organizations$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + patch( + params: Params$Resource$Organizations$Sources$Findings$Patch, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > ): void; - delete( - params: Params$Resource$Organizations$Operations$Delete, - callback: BodyResponseCallback + patch( + params: Params$Resource$Organizations$Sources$Findings$Patch, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > ): void; - delete(callback: BodyResponseCallback): void; - delete( + patch( + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > + ): void; + patch( paramsOrCallback?: - | Params$Resource$Organizations$Operations$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | Params$Resource$Organizations$Sources$Findings$Patch + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Operations$Delete; + {}) as Params$Resource$Organizations$Sources$Findings$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Operations$Delete; + params = {} as Params$Resource$Organizations$Sources$Findings$Patch; options = {}; } @@ -343,7 +3329,7 @@ export namespace securitycenter_v1p1beta1 { options: Object.assign( { url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'PATCH', }, options ), @@ -353,54 +3339,78 @@ export namespace securitycenter_v1p1beta1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >(parameters); } } /** - * securitycenter.organizations.operations.get - * @desc Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. - * @alias securitycenter.organizations.operations.get + * securitycenter.organizations.sources.findings.setState + * @desc Updates the state of a finding. + * @alias securitycenter.organizations.sources.findings.setState * @memberOf! () * * @param {object} params Parameters for request - * @param {string} params.name The name of the operation resource. + * @param {string} params.name Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/finding/{finding_id}". + * @param {().SetFindingStateRequest} params.requestBody Request 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$Organizations$Operations$Get, + setState( + params?: Params$Resource$Organizations$Sources$Findings$Setstate, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Organizations$Operations$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + ): GaxiosPromise; + setState( + params: Params$Resource$Organizations$Sources$Findings$Setstate, + options: + | MethodOptions + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > ): void; - get( - params: Params$Resource$Organizations$Operations$Get, - callback: BodyResponseCallback + setState( + params: Params$Resource$Organizations$Sources$Findings$Setstate, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > ): void; - get(callback: BodyResponseCallback): void; - get( + setState( + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > + ): void; + setState( paramsOrCallback?: - | Params$Resource$Organizations$Operations$Get - | BodyResponseCallback, + | Params$Resource$Organizations$Sources$Findings$Setstate + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + > + ): void | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Operations$Get; + {}) as Params$Resource$Organizations$Sources$Findings$Setstate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Operations$Get; + params = {} as Params$Resource$Organizations$Sources$Findings$Setstate; options = {}; } @@ -414,8 +3424,11 @@ export namespace securitycenter_v1p1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v1p1beta1/{+name}:setState').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', }, options ), @@ -425,59 +3438,82 @@ export namespace securitycenter_v1p1beta1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest( + parameters, + callback + ); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$GoogleCloudSecuritycenterV1p1beta1Finding + >(parameters); } } /** - * securitycenter.organizations.operations.list - * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. - * @alias securitycenter.organizations.operations.list + * securitycenter.organizations.sources.findings.updateSecurityMarks + * @desc Updates security marks. + * @alias securitycenter.organizations.sources.findings.updateSecurityMarks * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter The standard list filter. - * @param {string} params.name The name of the operation's parent resource. - * @param {integer=} params.pageSize The standard list page size. - * @param {string=} params.pageToken The standard list page token. + * @param {string} params.name The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". + * @param {string=} params.startTime The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. + * @param {string=} params.updateMask The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.". + * @param {().GoogleCloudSecuritycenterV1p1beta1SecurityMarks} params.requestBody Request 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$Organizations$Operations$List, + updateSecurityMarks( + params?: Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Organizations$Operations$List, + ): GaxiosPromise; + updateSecurityMarks( + params: Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > ): void; - list( - params: Params$Resource$Organizations$Operations$List, - callback: BodyResponseCallback + updateSecurityMarks( + params: Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks, + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > ): void; - list(callback: BodyResponseCallback): void; - list( + updateSecurityMarks( + callback: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > + ): void; + updateSecurityMarks( paramsOrCallback?: - | Params$Resource$Organizations$Operations$List - | BodyResponseCallback, + | Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >, optionsOrCallback?: | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { + | BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >, + callback?: BodyResponseCallback< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > + ): void | GaxiosPromise< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + > { let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Operations$List; + {}) as Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Operations$List; + params = {} as Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks; options = {}; } @@ -492,7 +3528,7 @@ export namespace securitycenter_v1p1beta1 { options: Object.assign( { url: (rootUrl + '/v1p1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', }, options ), @@ -502,14 +3538,18 @@ export namespace securitycenter_v1p1beta1 { context: this.context, }; if (callback) { - createAPIRequest(parameters, callback); + createAPIRequest< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >(parameters, callback); } else { - return createAPIRequest(parameters); + return createAPIRequest< + Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks + >(parameters); } } } - export interface Params$Resource$Organizations$Operations$Cancel + export interface Params$Resource$Organizations$Sources$Findings$Create extends StandardParameters { /** * Auth client or API Key for the request @@ -517,11 +3557,20 @@ export namespace securitycenter_v1p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the operation resource to be cancelled. + * Required. Unique identifier provided by the client within the parent scope. It must be alphanumeric and less than or equal to 32 characters and greater than 0 characters in length. */ - name?: string; + findingId?: string; + /** + * Required. Resource name of the new finding's parent. Its format should be "organizations/[organization_id]/sources/[source_id]". + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudSecuritycenterV1p1beta1Finding; } - export interface Params$Resource$Organizations$Operations$Delete + export interface Params$Resource$Organizations$Sources$Findings$Group extends StandardParameters { /** * Auth client or API Key for the request @@ -529,11 +3578,16 @@ export namespace securitycenter_v1p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the operation resource to be deleted. + * Required. Name of the source to groupBy. Its format is "organizations/[organization_id]/sources/[source_id]". To groupBy across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/- */ - name?: string; + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GroupFindingsRequest; } - export interface Params$Resource$Organizations$Operations$Get + export interface Params$Resource$Organizations$Sources$Findings$List extends StandardParameters { /** * Auth client or API Key for the request @@ -541,11 +3595,60 @@ export namespace securitycenter_v1p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The name of the operation resource. + * When compare_duration is set, the ListFindingsResult's "state_change" attribute is updated to indicate whether the finding had its state changed, the finding's state remained unchanged, or if the finding was added in any state during the compare_duration period of time that precedes the read_time. This is the time between (read_time - compare_duration) and read_time. The state_change value is derived based on the presence and state of the finding at the two points in time. Intermediate state changes between the two times don't affect the result. For example, the results aren't affected if the finding is made inactive and then active again. Possible "state_change" values when compare_duration is specified: * "CHANGED": indicates that the finding was present at the start of compare_duration, but changed its state at read_time. * "UNCHANGED": indicates that the finding was present at the start of compare_duration and did not change state at read_time. * "ADDED": indicates that the finding was not present at the start of compare_duration, but was present at read_time. If compare_duration is not specified, then the only possible state_change is "UNUSED", which will be the state_change set for all findings present at read_time. + */ + compareDuration?: string; + /** + * Optional. A field mask to specify the Finding fields to be listed in the response. An empty field mask will list all fields. + */ + fieldMask?: string; + /** + * Expression that defines the filter to apply across findings. The expression is a list of one or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. Examples include: * name * source_properties.a_property * security_marks.marks.marka The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. The following field and operator combinations are supported: name: `=` parent: `=`, `:` resource_name: `=`, `:` state: `=`, `:` category: `=`, `:` external_uri: `=`, `:` event_time: `=`, `>`, `<`, `>=`, `<=` Usage: This should be milliseconds since epoch or an RFC3339 string. Examples: "event_time = \"2019-06-10T16:07:18-07:00\"" "event_time = 1560208038000" security_marks.marks: `=`, `:` source_properties: `=`, `:`, `>`, `<`, `>=`, `<=` For example, `source_properties.size = 100` is a valid filter string. + */ + filter?: string; + /** + * Expression that defines what fields and order to use for sorting. The string value should follow SQL syntax: comma separated list of fields. For example: "name,resource_properties.a_property". The default sorting order is ascending. To specify descending order for a field, a suffix " desc" should be appended to the field name. For example: "name desc,source_properties.a_property". Redundant space characters in the syntax are insignificant. "name desc,source_properties.a_property" and " name desc , source_properties.a_property " are equivalent. The following fields are supported: name parent state category resource_name event_time source_properties security_marks.marks + */ + orderBy?: string; + /** + * The maximum number of results to return in a single response. Default is 10, minimum is 1, maximum is 1000. + */ + pageSize?: number; + /** + * The value returned by the last `ListFindingsResponse`; indicates that this is a continuation of a prior `ListFindings` call, and that the system should return the next page of data. + */ + pageToken?: string; + /** + * Required. Name of the source the findings belong to. Its format is "organizations/[organization_id]/sources/[source_id]". To list across all sources provide a source_id of `-`. For example: organizations/{organization_id}/sources/- + */ + parent?: string; + /** + * Time used as a reference point when filtering findings. The filter is limited to findings existing at the supplied time and their values are those at that specific time. Absence of this field will default to the API's version of NOW. + */ + readTime?: string; + } + export interface Params$Resource$Organizations$Sources$Findings$Patch + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The relative resource name of this finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}" */ name?: string; + /** + * The FieldMask to use when updating the finding resource. This field should not be specified when creating a finding. When updating a finding, an empty mask is treated as updating all mutable fields and replacing source_properties. Individual source_properties can be added/updated by using "source_properties." in the field mask. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudSecuritycenterV1p1beta1Finding; } - export interface Params$Resource$Organizations$Operations$List + export interface Params$Resource$Organizations$Sources$Findings$Setstate extends StandardParameters { /** * Auth client or API Key for the request @@ -553,20 +3656,38 @@ export namespace securitycenter_v1p1beta1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * The standard list filter. + * Required. The relative resource name of the finding. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}/finding/{finding_id}". */ - filter?: string; + name?: string; + /** - * The name of the operation's parent resource. + * Request body metadata + */ + requestBody?: Schema$SetFindingStateRequest; + } + export interface Params$Resource$Organizations$Sources$Findings$Updatesecuritymarks + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The relative resource name of the SecurityMarks. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Examples: "organizations/{organization_id}/assets/{asset_id}/securityMarks" "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}/securityMarks". */ name?: string; /** - * The standard list page size. + * The time at which the updated SecurityMarks take effect. If not set uses current server time. Updates will be applied to the SecurityMarks that are active immediately preceding this time. */ - pageSize?: number; + startTime?: string; /** - * The standard list page token. + * The FieldMask to use when updating the security marks resource. The field mask must not contain duplicate fields. If empty or set to "marks", all marks will be replaced. Individual marks can be updated using "marks.". */ - pageToken?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudSecuritycenterV1p1beta1SecurityMarks; } } diff --git a/src/apis/servicebroker/README.md b/src/apis/servicebroker/README.md deleted file mode 100644 index 36cda4605c..0000000000 --- a/src/apis/servicebroker/README.md +++ /dev/null @@ -1,47 +0,0 @@ -Google Inc. logo - -# servicebroker - -> The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). - -## 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/servicebroker -$ npm install -$ npm run webpack -``` - -The generated bundle will be written to `dist/servicebroker.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/servicebroker/index.ts b/src/apis/servicebroker/index.ts deleted file mode 100644 index 05c74d51be..0000000000 --- a/src/apis/servicebroker/index.ts +++ /dev/null @@ -1,62 +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. - -/*! THIS FILE IS AUTO-GENERATED */ - -import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; -import {servicebroker_v1} from './v1'; -import {servicebroker_v1alpha1} from './v1alpha1'; -import {servicebroker_v1beta1} from './v1beta1'; - -export const VERSIONS = { - v1: servicebroker_v1.Servicebroker, - v1alpha1: servicebroker_v1alpha1.Servicebroker, - v1beta1: servicebroker_v1beta1.Servicebroker, -}; - -export function servicebroker(version: 'v1'): servicebroker_v1.Servicebroker; -export function servicebroker( - options: servicebroker_v1.Options -): servicebroker_v1.Servicebroker; -export function servicebroker( - version: 'v1alpha1' -): servicebroker_v1alpha1.Servicebroker; -export function servicebroker( - options: servicebroker_v1alpha1.Options -): servicebroker_v1alpha1.Servicebroker; -export function servicebroker( - version: 'v1beta1' -): servicebroker_v1beta1.Servicebroker; -export function servicebroker( - options: servicebroker_v1beta1.Options -): servicebroker_v1beta1.Servicebroker; -export function servicebroker< - T = - | servicebroker_v1.Servicebroker - | servicebroker_v1alpha1.Servicebroker - | servicebroker_v1beta1.Servicebroker ->( - this: GoogleConfigurable, - versionOrOptions: - | 'v1' - | servicebroker_v1.Options - | 'v1alpha1' - | servicebroker_v1alpha1.Options - | 'v1beta1' - | servicebroker_v1beta1.Options -) { - return getAPI('servicebroker', versionOrOptions, VERSIONS, this); -} - -const auth = new AuthPlus(); -export {auth}; diff --git a/src/apis/servicebroker/tsconfig.json b/src/apis/servicebroker/tsconfig.json deleted file mode 100644 index e081090496..0000000000 --- a/src/apis/servicebroker/tsconfig.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "extends": "./node_modules/gts/tsconfig-google.json", - "compilerOptions": { - "rootDir": ".", - "outDir": "build" - }, - "include": [ - "*.ts", - ] -} diff --git a/src/apis/servicebroker/v1.ts b/src/apis/servicebroker/v1.ts deleted file mode 100644 index ee8a0ecc97..0000000000 --- a/src/apis/servicebroker/v1.ts +++ /dev/null @@ -1,503 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace servicebroker_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; - } - - /** - * Service Broker API - * - * The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). - * - * @example - * const {google} = require('googleapis'); - * const servicebroker = google.servicebroker('v1'); - * - * @namespace servicebroker - * @type {Function} - * @version v1 - * @variation v1 - * @param {object=} options Options for Servicebroker - */ - export class Servicebroker { - context: APIRequestContext; - v1: Resource$V1; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.v1 = new Resource$V1(this.context); - } - } - - /** - * Associates `members` with a `role`. - */ - export interface Schema$GoogleIamV1__Binding { - /** - * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. - */ - condition?: Schema$GoogleType__Expr; - /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. - */ - members?: string[] | null; - /** - * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. - */ - role?: string | null; - } - /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - */ - export interface Schema$GoogleIamV1__Policy { - /** - * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. - */ - bindings?: Schema$GoogleIamV1__Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - */ - etag?: string | null; - /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. - */ - version?: number | null; - } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$GoogleIamV1__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$GoogleIamV1__Policy; - } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$GoogleIamV1__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[] | null; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$GoogleIamV1__TestIamPermissionsResponse { - /** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - */ - permissions?: string[] | null; - } - /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" - */ - export interface Schema$GoogleType__Expr { - /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - */ - description?: string | null; - /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. - */ - expression?: string | null; - /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - */ - location?: string | null; - /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. - */ - title?: string | null; - } - - export class Resource$V1 { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.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 servicebroker.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - * @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$V1$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$V1$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$V1$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$V1$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$V1$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+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); - } - } - - /** - * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED - * @alias servicebroker.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 {().GoogleIamV1__SetIamPolicyRequest} params.requestBody Request 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$V1$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$V1$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$V1$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$V1$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || {}) as Params$Resource$V1$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+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); - } - } - - /** - * servicebroker.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 servicebroker.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 {().GoogleIamV1__TestIamPermissionsRequest} params.requestBody Request 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$V1$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$V1$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - params: Params$Resource$V1$Testiampermissions, - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$V1$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$V1$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+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$V1$Getiampolicy extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$V1$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$GoogleIamV1__SetIamPolicyRequest; - } - export interface Params$Resource$V1$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$GoogleIamV1__TestIamPermissionsRequest; - } -} diff --git a/src/apis/servicebroker/v1alpha1.ts b/src/apis/servicebroker/v1alpha1.ts deleted file mode 100644 index 1152f16f02..0000000000 --- a/src/apis/servicebroker/v1alpha1.ts +++ /dev/null @@ -1,2598 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace servicebroker_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; - } - - /** - * Service Broker API - * - * The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). - * - * @example - * const {google} = require('googleapis'); - * const servicebroker = google.servicebroker('v1alpha1'); - * - * @namespace servicebroker - * @type {Function} - * @version v1alpha1 - * @variation v1alpha1 - * @param {object=} options Options for Servicebroker - */ - export class Servicebroker { - context: APIRequestContext; - projects: Resource$Projects; - v1alpha1: Resource$V1alpha1; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.projects = new Resource$Projects(this.context); - this.v1alpha1 = new Resource$V1alpha1(this.context); - } - } - - /** - * Describes the binding. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__Binding { - /** - * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - binding_id?: string | null; - /** - * A JSON object that contains data for platform resources associated with the binding to be created. - */ - bind_resource?: {[key: string]: any} | null; - /** - * Output only. Timestamp for when the binding was created. - */ - createTime?: string | null; - /** - * Configuration options for the service binding. - */ - parameters?: {[key: string]: any} | null; - /** - * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. - */ - plan_id?: string | null; - /** - * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. - */ - service_id?: string | null; - } - /** - * Response for the `CreateBinding()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse { - /** - * Credentials to use the binding. - */ - credentials?: {[key: string]: any} | null; - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always executes all create/delete operations asynchronously. - */ - operation?: string | null; - /** - * A URL to which the platform may proxy requests for the address sent with bind_resource.route - */ - route_service_url?: string | null; - /** - * From where to read system logs. - */ - syslog_drain_url?: string | null; - /** - * An array of configuration for mounting volumes. - */ - volume_mounts?: Array<{[key: string]: any}> | null; - } - /** - * Response for the `CreateServiceInstance()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always will return a non-empty operation on success. - */ - operation?: string | null; - } - /** - * Message containing information required to activate Dashboard SSO feature. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__DashboardClient { - /** - * The id of the Oauth client that the dashboard will use. - */ - id?: string | null; - /** - * A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token. - */ - redirect_uri?: string | null; - /** - * A secret for the dashboard client. - */ - secret?: string | null; - } - /** - * Response for the `DeleteBinding()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. - */ - operation?: string | null; - } - /** - * Response for the `DeleteServiceInstance()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. - */ - operation?: string | null; - } - /** - * Response for the `GetBinding()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse { - /** - * Credentials to use the binding. - */ - credentials?: {[key: string]: any} | null; - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * A URL to which the platform may proxy requests for the address sent with bind_resource.route - */ - route_service_url?: string | null; - /** - * From where to read system logs. - */ - syslog_drain_url?: string | null; - /** - * An array of configuration for mounting volumes. - */ - volume_mounts?: Array<{[key: string]: any}> | null; - } - /** - * The response for the `ListBindings()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse { - /** - * The list of the bindings in the instance. - */ - bindings?: Schema$GoogleCloudServicebrokerV1alpha1__Binding[]; - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results - */ - nextPageToken?: string | null; - } - /** - * Response message for the `ListCatalog()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results - */ - nextPageToken?: string | null; - /** - * The services available for the requested GCP project. - */ - services?: Schema$GoogleCloudServicebrokerV1alpha1__Service[]; - } - /** - * The response for the `ListServiceInstances()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * The list of the instances in the broker. - */ - instances?: Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance[]; - /** - * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results - */ - nextPageToken?: string | null; - } - /** - * Describes a long running operation, which conforms to OpenService API. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__Operation { - /** - * Optional description of the Operation state. - */ - description?: string | null; - /** - * The state of the operation. Valid values are: "in progress", "succeeded", and "failed". - */ - state?: string | null; - } - /** - * Plan message describes a Service Plan. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__Plan { - /** - * Specifies whether instances of the service can be bound to applications. If not specified, `Service.bindable` will be presumed. - */ - bindable?: boolean | null; - /** - * Textual description of the plan. Optional. - */ - description?: string | null; - /** - * Whether the service is free. - */ - free?: boolean | null; - /** - * ID is a globally unique identifier used to uniquely identify the plan. User must make no presumption about the format of this field. - */ - id?: string | null; - /** - * A list of metadata for a service offering. Metadata is an arbitrary JSON object. - */ - metadata?: {[key: string]: any} | null; - /** - * User friendly name of the plan. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). - */ - name?: string | null; - /** - * Schema definitions for service instances and bindings for the plan. - */ - schemas?: {[key: string]: any} | null; - } - /** - * The resource model mostly follows the Open Service Broker API, as described here: https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md Though due to Google Specifics it has additional optional fields. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__Service { - /** - * Specifies whether instances of the service can be bound to applications. Required. - */ - bindable?: boolean | null; - /** - * Whether the service provides an endpoint to get service bindings. - */ - binding_retrievable?: boolean | null; - /** - * Information to activate Dashboard SSO feature. - */ - dashboard_client?: Schema$GoogleCloudServicebrokerV1alpha1__DashboardClient; - /** - * Textual description of the service. Required. - */ - description?: string | null; - /** - * ID is a globally unique identifier used to uniquely identify the service. ID is an opaque string. - */ - id?: string | null; - /** - * Whether the service provides an endpoint to get service instances. - */ - instance_retrievable?: boolean | null; - /** - * A list of metadata for a service offering. Metadata is an arbitrary JSON object. - */ - metadata?: {[key: string]: any} | null; - /** - * User friendly service name. Name must match [a-z0-9]+ regexp. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). Required. - */ - name?: string | null; - /** - * A list of plans for this service. At least one plan is required. - */ - plans?: Schema$GoogleCloudServicebrokerV1alpha1__Plan[]; - /** - * Whether the service supports upgrade/downgrade for some plans. - */ - plan_updateable?: boolean | null; - /** - * Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service. - */ - tags?: string[] | null; - } - /** - * Message describing inputs to Provision and Update Service instance requests. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance { - /** - * Platform specific contextual information under which the service instance is to be provisioned. This replaces organization_guid and space_guid. But can also contain anything. Currently only used for logging context information. - */ - context?: {[key: string]: any} | null; - /** - * Output only. Timestamp for when the instance was created. - */ - createTime?: string | null; - /** - * Output only. Name of the Deployment Manager deployment used for provisioning of this service instance. - */ - deploymentName?: string | null; - /** - * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - instance_id?: string | null; - /** - * The platform GUID for the organization under which the service is to be provisioned. Required. - */ - organization_guid?: string | null; - /** - * Configuration options for the service instance. Parameters is JSON object serialized to string. - */ - parameters?: {[key: string]: any} | null; - /** - * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. - */ - plan_id?: string | null; - /** - * Used only in UpdateServiceInstance request to optionally specify previous fields. - */ - previous_values?: {[key: string]: any} | null; - /** - * Output only. The resource name of the instance, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id - */ - resourceName?: string | null; - /** - * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. - */ - service_id?: string | null; - /** - * The identifier for the project space within the platform organization. Required. - */ - space_guid?: string | null; - } - /** - * Response for the `UpdateServiceInstance()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. - */ - operation?: string | null; - } - /** - * Associates `members` with a `role`. - */ - export interface Schema$GoogleIamV1__Binding { - /** - * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. - */ - condition?: Schema$GoogleType__Expr; - /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. - */ - members?: string[] | null; - /** - * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. - */ - role?: string | null; - } - /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - */ - export interface Schema$GoogleIamV1__Policy { - /** - * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. - */ - bindings?: Schema$GoogleIamV1__Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - */ - etag?: string | null; - /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. - */ - version?: number | null; - } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$GoogleIamV1__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$GoogleIamV1__Policy; - } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$GoogleIamV1__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[] | null; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$GoogleIamV1__TestIamPermissionsResponse { - /** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - */ - permissions?: string[] | null; - } - /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" - */ - export interface Schema$GoogleType__Expr { - /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - */ - description?: string | null; - /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. - */ - expression?: string | null; - /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - */ - location?: string | null; - /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. - */ - title?: string | null; - } - - export class Resource$Projects { - context: APIRequestContext; - brokers: Resource$Projects$Brokers; - constructor(context: APIRequestContext) { - this.context = context; - this.brokers = new Resource$Projects$Brokers(this.context); - } - } - - export class Resource$Projects$Brokers { - context: APIRequestContext; - instances: Resource$Projects$Brokers$Instances; - service_instances: Resource$Projects$Brokers$Service_instances; - v2: Resource$Projects$Brokers$V2; - constructor(context: APIRequestContext) { - this.context = context; - this.instances = new Resource$Projects$Brokers$Instances(this.context); - this.service_instances = new Resource$Projects$Brokers$Service_instances( - this.context - ); - this.v2 = new Resource$Projects$Brokers$V2(this.context); - } - } - - export class Resource$Projects$Brokers$Instances { - context: APIRequestContext; - service_bindings: Resource$Projects$Brokers$Instances$Service_bindings; - constructor(context: APIRequestContext) { - this.context = context; - this.service_bindings = new Resource$Projects$Brokers$Instances$Service_bindings( - this.context - ); - } - - /** - * servicebroker.projects.brokers.instances.get - * @desc Gets the given service instance from the system. This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. - * @alias servicebroker.projects.brokers.instances.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the instance to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Brokers$Instances$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Brokers$Instances$Get, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > - ): void; - get( - params: Params$Resource$Projects$Brokers$Instances$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > - ): void; - get( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Instances$Get - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Instances$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Instances$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$Instances$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the instance to return. - */ - name?: string; - } - - export class Resource$Projects$Brokers$Instances$Service_bindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.projects.brokers.instances.service_bindings.list - * @desc Lists all the bindings in the instance - * @alias servicebroker.projects.brokers.instances.service_bindings.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. - * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Brokers$Instances$Service_bindings$List, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - >; - list( - params: Params$Resource$Projects$Brokers$Instances$Service_bindings$List, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - > - ): void; - list( - params: Params$Resource$Projects$Brokers$Instances$Service_bindings$List, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Instances$Service_bindings$List - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Instances$Service_bindings$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Instances$Service_bindings$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+parent}/service_bindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ListBindingsResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$Instances$Service_bindings$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. - */ - pageSize?: number; - /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - */ - parent?: string; - } - - export class Resource$Projects$Brokers$Service_instances { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.projects.brokers.service_instances.list - * @desc Lists all the instances in the brokers This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. - * @alias servicebroker.projects.brokers.service_instances.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. - * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_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$Brokers$Service_instances$List, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - >; - list( - params: Params$Resource$Projects$Brokers$Service_instances$List, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - > - ): void; - list( - params: Params$Resource$Projects$Brokers$Service_instances$List, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Service_instances$List - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Service_instances$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Service_instances$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+parent}/service_instances').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ListServiceInstancesResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$Service_instances$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. - */ - pageSize?: number; - /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - } - - export class Resource$Projects$Brokers$V2 { - context: APIRequestContext; - catalog: Resource$Projects$Brokers$V2$Catalog; - service_instances: Resource$Projects$Brokers$V2$Service_instances; - constructor(context: APIRequestContext) { - this.context = context; - this.catalog = new Resource$Projects$Brokers$V2$Catalog(this.context); - this.service_instances = new Resource$Projects$Brokers$V2$Service_instances( - this.context - ); - } - } - - export class Resource$Projects$Brokers$V2$Catalog { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.projects.brokers.v2.catalog.list - * @desc Lists all the Services registered with this broker for consumption for given service registry broker, which contains an set of services. Note, that Service producer API is separate from Broker API. - * @alias servicebroker.projects.brokers.v2.catalog.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. - * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_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$Brokers$V2$Catalog$List, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - >; - list( - params: Params$Resource$Projects$Brokers$V2$Catalog$List, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - > - ): void; - list( - params: Params$Resource$Projects$Brokers$V2$Catalog$List, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Catalog$List - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Catalog$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Catalog$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+parent}/v2/catalog').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ListCatalogResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$V2$Catalog$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. - */ - pageSize?: number; - /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - } - - export class Resource$Projects$Brokers$V2$Service_instances { - context: APIRequestContext; - service_bindings: Resource$Projects$Brokers$V2$Service_instances$Service_bindings; - constructor(context: APIRequestContext) { - this.context = context; - this.service_bindings = new Resource$Projects$Brokers$V2$Service_instances$Service_bindings( - this.context - ); - } - - /** - * servicebroker.projects.brokers.v2.service_instances.create - * @desc Provisions a service instance. If `request.accepts_incomplete` is false and Broker cannot execute request synchronously HTTP 422 error will be returned along with FAILED_PRECONDITION status. If `request.accepts_incomplete` is true and the Broker decides to execute resource asynchronously then HTTP 202 response code will be returned and a valid polling operation in the response will be included. If Broker executes the request synchronously and it succeeds HTTP 201 response will be furnished. If identical instance exists, then HTTP 200 response will be returned. If an instance with identical ID but mismatching parameters exists, then HTTP 409 status code will be returned. - * @alias servicebroker.projects.brokers.v2.service_instances.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous. - * @param {string} params.instance_id The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {().GoogleCloudServicebrokerV1alpha1__ServiceInstance} params.requestBody Request 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$Brokers$V2$Service_instances$Create, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - >; - create( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Create, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - > - ): void; - create( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - > - ): void; - create( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - > - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Create - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1alpha1/{+parent}/v2/service_instances/{+instance_id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['parent', 'instance_id'], - pathParams: ['instance_id', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__CreateServiceInstanceResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.delete - * @desc Deprovisions a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If service instance does not exist HTTP 410 status will be returned. - * @alias servicebroker.projects.brokers.v2.service_instances.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. - * @param {string} params.instanceId The instance id to deprovision. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {string=} params.planId The plan id of the service instance. - * @param {string=} params.serviceId The service id of the service instance. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - >; - delete( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - > - ): void; - delete( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - > - ): void; - delete( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - > - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Delete - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1alpha1/{+parent}/v2/service_instances/{+instanceId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['parent', 'instanceId'], - pathParams: ['instanceId', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteServiceInstanceResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.get - * @desc Gets the given service instance from the system. This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. - * @alias servicebroker.projects.brokers.v2.service_instances.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the instance to return. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Get, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > - ): void; - get( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > - ): void; - get( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Get - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.getLast_operation - * @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled. - * @alias servicebroker.projects.brokers.v2.service_instances.getLast_operation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.instanceId The instance id for which to return the last operation status. - * @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {string=} params.planId Plan id. - * @param {string=} params.serviceId Service 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 - */ - getLast_operation( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, - options?: MethodOptions - ): GaxiosPromise; - getLast_operation( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > - ): void; - getLast_operation( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > - ): void; - getLast_operation( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > - ): void; - getLast_operation( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1alpha1/{+parent}/v2/service_instances/{+instanceId}/last_operation' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'instanceId'], - pathParams: ['instanceId', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.patch - * @desc Updates an existing service instance. See CreateServiceInstance for possible response codes. - * @alias servicebroker.projects.brokers.v2.service_instances.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. - * @param {string} params.instance_id The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {().GoogleCloudServicebrokerV1alpha1__ServiceInstance} params.requestBody Request 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$Brokers$V2$Service_instances$Patch, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - >; - patch( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - > - ): void; - patch( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - > - ): void; - patch( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - > - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Patch - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1alpha1/{+parent}/v2/service_instances/{+instance_id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['parent', 'instance_id'], - pathParams: ['instance_id', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__UpdateServiceInstanceResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous. - */ - acceptsIncomplete?: boolean; - /** - * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - instance_id?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * See CreateServiceInstanceRequest for details. - */ - acceptsIncomplete?: boolean; - /** - * The instance id to deprovision. - */ - instanceId?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - /** - * The plan id of the service instance. - */ - planId?: string; - /** - * The service id of the service instance. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the instance to return. - */ - name?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The instance id for which to return the last operation status. - */ - instanceId?: string; - /** - * If `operation` was returned during mutation operation, this field must be populated with the provided value. - */ - operation?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - /** - * Plan id. - */ - planId?: string; - /** - * Service id. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * See CreateServiceInstanceRequest for details. - */ - acceptsIncomplete?: boolean; - /** - * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - instance_id?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudServicebrokerV1alpha1__ServiceInstance; - } - - export class Resource$Projects$Brokers$V2$Service_instances$Service_bindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.projects.brokers.v2.service_instances.service_bindings.create - * @desc CreateBinding generates a service binding to an existing service instance. See ProviServiceInstance for async operation details. - * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. - * @param {string} params.binding_id The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - * @param {string} params.instanceId The service instance to which to bind. - * @param {string} params.parent The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {().GoogleCloudServicebrokerV1alpha1__Binding} params.requestBody Request 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$Brokers$V2$Service_instances$Service_bindings$Create, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - >; - create( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - > - ): void; - create( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - > - ): void; - create( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - > - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1alpha1/{+parent}/v2/service_instances/{+instanceId}/service_bindings/{+binding_id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['parent', 'instanceId', 'binding_id'], - pathParams: ['binding_id', 'instanceId', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__CreateBindingResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.service_bindings.delete - * @desc Unbinds from a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If binding does not exist HTTP 410 status will be returned. - * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. - * @param {string} params.bindingId The id of the binding to delete. - * @param {string} params.instanceId The service instance id that deleted binding is bound to. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {string=} params.planId The plan id of the service instance. - * @param {string=} params.serviceId Additional query parameter hints. The service id of the service instance. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - >; - delete( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - > - ): void; - delete( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - > - ): void; - delete( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - > - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1alpha1/{+parent}/v2/service_instances/{instanceId}/service_bindings/{bindingId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['parent', 'instanceId', 'bindingId'], - pathParams: ['bindingId', 'instanceId', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__DeleteBindingResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.service_bindings.get - * @desc GetBinding returns the binding information. - * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.bindingId The binding id. - * @param {string} params.instanceId Instance id to which the binding is bound. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {string=} params.planId Plan id. - * @param {string=} params.serviceId Service 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$Brokers$V2$Service_instances$Service_bindings$Get, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - >; - get( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - > - ): void; - get( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - > - ): void; - get( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - > - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1alpha1/{+parent}/v2/service_instances/{+instanceId}/service_bindings/{+bindingId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'instanceId', 'bindingId'], - pathParams: ['bindingId', 'instanceId', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__GetBindingResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation - * @desc Returns the state of the last operation for the binding. Only last (or current) operation can be polled. - * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.bindingId The binding id for which to return the last operation - * @param {string} params.instanceId The instance id that the binding is bound to. - * @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {string=} params.planId Plan id. - * @param {string=} params.serviceId Service 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 - */ - getLast_operation( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, - options?: MethodOptions - ): GaxiosPromise; - getLast_operation( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > - ): void; - getLast_operation( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > - ): void; - getLast_operation( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > - ): void; - getLast_operation( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + - '/v1alpha1/{+parent}/v2/service_instances/{+instanceId}/service_bindings/{+bindingId}/last_operation' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent', 'instanceId', 'bindingId'], - pathParams: ['bindingId', 'instanceId', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1alpha1__Operation - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * See CreateServiceInstanceRequest for details. - */ - acceptsIncomplete?: boolean; - /** - * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - binding_id?: string; - /** - * The service instance to which to bind. - */ - instanceId?: string; - /** - * The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudServicebrokerV1alpha1__Binding; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * See CreateServiceInstanceRequest for details. - */ - acceptsIncomplete?: boolean; - /** - * The id of the binding to delete. - */ - bindingId?: string; - /** - * The service instance id that deleted binding is bound to. - */ - instanceId?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - /** - * The plan id of the service instance. - */ - planId?: string; - /** - * Additional query parameter hints. The service id of the service instance. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The binding id. - */ - bindingId?: string; - /** - * Instance id to which the binding is bound. - */ - instanceId?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - /** - * Plan id. - */ - planId?: string; - /** - * Service id. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The binding id for which to return the last operation - */ - bindingId?: string; - /** - * The instance id that the binding is bound to. - */ - instanceId?: string; - /** - * If `operation` was returned during mutation operation, this field must be populated with the provided value. - */ - operation?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - /** - * Plan id. - */ - planId?: string; - /** - * Service id. - */ - serviceId?: string; - } - - export class Resource$V1alpha1 { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.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 servicebroker.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - * @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$V1alpha1$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$V1alpha1$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$V1alpha1$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$V1alpha1$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$V1alpha1$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1alpha1$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+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); - } - } - - /** - * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED - * @alias servicebroker.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 {().GoogleIamV1__SetIamPolicyRequest} params.requestBody Request 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$V1alpha1$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$V1alpha1$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$V1alpha1$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$V1alpha1$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$V1alpha1$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1alpha1$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+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); - } - } - - /** - * servicebroker.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 servicebroker.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 {().GoogleIamV1__TestIamPermissionsRequest} params.requestBody Request 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$V1alpha1$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$V1alpha1$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - params: Params$Resource$V1alpha1$Testiampermissions, - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$V1alpha1$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$V1alpha1$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1alpha1$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha1/{+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$V1alpha1$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$V1alpha1$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$GoogleIamV1__SetIamPolicyRequest; - } - export interface Params$Resource$V1alpha1$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$GoogleIamV1__TestIamPermissionsRequest; - } -} diff --git a/src/apis/servicebroker/v1beta1.ts b/src/apis/servicebroker/v1beta1.ts deleted file mode 100644 index bba73a816a..0000000000 --- a/src/apis/servicebroker/v1beta1.ts +++ /dev/null @@ -1,3151 +0,0 @@ -// Copyright 2019 Google LLC -// -// Licensed under the Apache License, Version 2.0 (the "License"); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -import { - OAuth2Client, - JWT, - Compute, - UserRefreshClient, -} from 'google-auth-library'; -import { - GoogleConfigurable, - createAPIRequest, - MethodOptions, - GlobalOptions, - BodyResponseCallback, - APIRequestContext, -} from 'googleapis-common'; -import {GaxiosPromise} from 'gaxios'; - -// tslint:disable: no-any -// tslint:disable: class-name -// tslint:disable: variable-name -// tslint:disable: jsdoc-format -// tslint:disable: no-namespace - -export namespace servicebroker_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; - } - - /** - * Service Broker API - * - * The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/). - * - * @example - * const {google} = require('googleapis'); - * const servicebroker = google.servicebroker('v1beta1'); - * - * @namespace servicebroker - * @type {Function} - * @version v1beta1 - * @variation v1beta1 - * @param {object=} options Options for Servicebroker - */ - export class Servicebroker { - context: APIRequestContext; - projects: Resource$Projects; - v1beta1: Resource$V1beta1; - - constructor(options: GlobalOptions, google?: GoogleConfigurable) { - this.context = { - _options: options || {}, - google, - }; - - this.projects = new Resource$Projects(this.context); - this.v1beta1 = new Resource$V1beta1(this.context); - } - } - - /** - * Describes the binding. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__Binding { - /** - * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - binding_id?: string | null; - /** - * A JSON object that contains data for platform resources associated with the binding to be created. - */ - bind_resource?: {[key: string]: any} | null; - /** - * Output only. Timestamp for when the binding was created. - */ - createTime?: string | null; - /** - * Output only. String containing the Deployment Manager deployment name that was created for this binding, - */ - deploymentName?: string | null; - /** - * Configuration options for the service binding. - */ - parameters?: {[key: string]: any} | null; - /** - * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. - */ - plan_id?: string | null; - /** - * Output only. The resource name of the binding, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id. - */ - resourceName?: string | null; - /** - * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. - */ - service_id?: string | null; - } - /** - * Broker represents a consumable collection of Service Registry catalogs exposed as an OSB Broker. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__Broker { - /** - * Output only. Timestamp for when the broker was created. - */ - createTime?: string | null; - /** - * Name of the broker in the format: <projects>/<project-id>/brokers/<broker>. This allows for multiple brokers per project which can be used to enable having custom brokers per GKE cluster, for example. - */ - name?: string | null; - /** - * User friendly title of the broker. Limited to 1024 characters. Requests with longer titles will be rejected. - */ - title?: string | null; - /** - * Output only. URL of the broker OSB-compliant endpoint, for example: https://servicebroker.googleapis.com/projects/<project>/brokers/<broker> - */ - url?: string | null; - } - /** - * Response for the `CreateBinding()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse { - /** - * Credentials to use the binding. - */ - credentials?: {[key: string]: any} | null; - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always executes all create/delete operations asynchronously. - */ - operation?: string | null; - /** - * A URL to which the platform may proxy requests for the address sent with bind_resource.route - */ - route_service_url?: string | null; - /** - * From where to read system logs. - */ - syslog_drain_url?: string | null; - /** - * An array of configuration for mounting volumes. - */ - volume_mounts?: Array<{[key: string]: any}> | null; - } - /** - * Response for the `CreateServiceInstance()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. This broker always will return a non-empty operation on success. - */ - operation?: string | null; - } - /** - * Message containing information required to activate Dashboard SSO feature. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__DashboardClient { - /** - * The id of the Oauth client that the dashboard will use. - */ - id?: string | null; - /** - * A URI for the service dashboard. Validated by the OAuth token server when the dashboard requests a token. - */ - redirect_uri?: string | null; - /** - * A secret for the dashboard client. - */ - secret?: string | null; - } - /** - * Response for the `DeleteBinding()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. - */ - operation?: string | null; - } - /** - * Response for the `DeleteServiceInstance()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. - */ - operation?: string | null; - } - /** - * Response for the `GetBinding()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse { - /** - * Credentials to use the binding. - */ - credentials?: {[key: string]: any} | null; - /** - * String containing the Deployment Manager deployment name that was created for this binding, - */ - deploymentName?: string | null; - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * Output only. The resource name of the binding, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id. - */ - resourceName?: string | null; - /** - * A URL to which the platform may proxy requests for the address sent with bind_resource.route - */ - route_service_url?: string | null; - /** - * From where to read system logs. - */ - syslog_drain_url?: string | null; - /** - * An array of configurations for mounting volumes. - */ - volume_mounts?: Array<{[key: string]: any}> | null; - } - /** - * The response for the `ListBindings()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse { - /** - * The list of bindings in the instance. - */ - bindings?: Schema$GoogleCloudServicebrokerV1beta1__Binding[]; - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results - */ - nextPageToken?: string | null; - } - /** - * The response for the `ListBrokers()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse { - /** - * The list of brokers in the container. - */ - brokers?: Schema$GoogleCloudServicebrokerV1beta1__Broker[]; - /** - * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results - */ - nextPageToken?: string | null; - } - /** - * Response message for the `ListCatalog()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results - */ - nextPageToken?: string | null; - /** - * The services available for the requested GCP project. - */ - services?: Schema$GoogleCloudServicebrokerV1beta1__Service[]; - } - /** - * The response for the `ListServiceInstances()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * The list of instances in the broker. - */ - instances?: Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance[]; - /** - * This token allows you to get the next page of results for list requests. If the number of results is larger than `pageSize`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results - */ - nextPageToken?: string | null; - } - /** - * Describes a long running operation, which conforms to OpenService API. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__Operation { - /** - * Optional description of the Operation state. - */ - description?: string | null; - /** - * The state of the operation. Valid values are: "in progress", "succeeded", and "failed". - */ - state?: string | null; - } - /** - * Plan message describes a Service Plan. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__Plan { - /** - * Specifies whether instances of the service can be bound to applications. If not specified, `Service.bindable` will be presumed. - */ - bindable?: boolean | null; - /** - * Textual description of the plan. Optional. - */ - description?: string | null; - /** - * Whether the service is free. - */ - free?: boolean | null; - /** - * ID is a globally unique identifier used to uniquely identify the plan. User must make no presumption about the format of this field. - */ - id?: string | null; - /** - * A list of metadata for a service offering. Metadata is an arbitrary JSON object. - */ - metadata?: {[key: string]: any} | null; - /** - * User friendly name of the plan. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). - */ - name?: string | null; - /** - * Schema definitions for service instances and bindings for the plan. - */ - schemas?: {[key: string]: any} | null; - } - /** - * The resource model mostly follows the Open Service Broker API, as described here: https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md Though due to Google Specifics it has additional optional fields. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__Service { - /** - * Specifies whether instances of the service can be bound to applications. Required. - */ - bindable?: boolean | null; - /** - * Whether the service provides an endpoint to get service bindings. - */ - bindings_retrievable?: boolean | null; - /** - * Whether the service provides an endpoint to get service bindings. - */ - binding_retrievable?: boolean | null; - /** - * Information to activate Dashboard SSO feature. - */ - dashboard_client?: Schema$GoogleCloudServicebrokerV1beta1__DashboardClient; - /** - * Textual description of the service. Required. - */ - description?: string | null; - /** - * ID is a globally unique identifier used to uniquely identify the service. ID is an opaque string. - */ - id?: string | null; - /** - * Whether the service provides an endpoint to get service instances. - */ - instances_retrievable?: boolean | null; - /** - * A list of metadata for a service offering. Metadata is an arbitrary JSON object. - */ - metadata?: {[key: string]: any} | null; - /** - * User friendly service name. Name must match [a-z0-9]+ regexp. The name must be globally unique within GCP project. Note, which is different from ("This must be globally unique within a platform marketplace"). Required. - */ - name?: string | null; - /** - * A list of plans for this service. At least one plan is required. - */ - plans?: Schema$GoogleCloudServicebrokerV1beta1__Plan[]; - /** - * Whether the service supports upgrade/downgrade for some plans. - */ - plan_updateable?: boolean | null; - /** - * Tags provide a flexible mechanism to expose a classification, attribute, or base technology of a service. - */ - tags?: string[] | null; - } - /** - * Message describing inputs to Provision and Update Service instance requests. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance { - /** - * Platform specific contextual information under which the service instance is to be provisioned. This replaces organization_guid and space_guid. But can also contain anything. Currently only used for logging context information. - */ - context?: {[key: string]: any} | null; - /** - * Output only. Timestamp for when the instance was created. - */ - createTime?: string | null; - /** - * Output only. String containing the Deployment Manager deployment name that was created for this instance, - */ - deploymentName?: string | null; - /** - * To return errors when GetInstance call is done via HTTP to be unified with other methods. - */ - description?: string | null; - /** - * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - instance_id?: string | null; - /** - * The platform GUID for the organization under which the service is to be provisioned. Required. - */ - organization_guid?: string | null; - /** - * Configuration options for the service instance. Parameters is JSON object serialized to string. - */ - parameters?: {[key: string]: any} | null; - /** - * The ID of the plan. See `Service` and `Plan` resources for details. Maximum length is 64, GUID recommended. Required. - */ - plan_id?: string | null; - /** - * Used only in UpdateServiceInstance request to optionally specify previous fields. - */ - previous_values?: {[key: string]: any} | null; - /** - * Output only. The resource name of the instance, e.g. projects/project_id/brokers/broker_id/service_instances/instance_id - */ - resourceName?: string | null; - /** - * The id of the service. Must be a valid identifier of a service contained in the list from a `ListServices()` call. Maximum length is 64, GUID recommended. Required. - */ - service_id?: string | null; - /** - * The identifier for the project space within the platform organization. Required. - */ - space_guid?: string | null; - } - /** - * Response for the `UpdateServiceInstance()` method. - */ - export interface Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse { - /** - * Used to communicate description of the response. Usually for non-standard error codes. https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors - */ - description?: string | null; - /** - * If broker executes operation asynchronously, this is the operation ID that can be polled to check the completion status of said operation. - */ - operation?: string | null; - } - /** - * Associates `members` with a `role`. - */ - export interface Schema$GoogleIamV1__Binding { - /** - * The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. - */ - condition?: Schema$GoogleType__Expr; - /** - * Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. - */ - members?: string[] | null; - /** - * Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. - */ - role?: string | null; - } - /** - * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. Optionally, a `binding` can specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). - */ - export interface Schema$GoogleIamV1__Policy { - /** - * Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member. - */ - bindings?: Schema$GoogleIamV1__Binding[]; - /** - * `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. - */ - etag?: string | null; - /** - * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. - */ - version?: number | null; - } - /** - * Request message for `SetIamPolicy` method. - */ - export interface Schema$GoogleIamV1__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$GoogleIamV1__Policy; - } - /** - * Request message for `TestIamPermissions` method. - */ - export interface Schema$GoogleIamV1__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[] | null; - } - /** - * Response message for `TestIamPermissions` method. - */ - export interface Schema$GoogleIamV1__TestIamPermissionsResponse { - /** - * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. - */ - permissions?: string[] | null; - } - /** - * 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$GoogleProtobuf__Empty {} - /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" - */ - export interface Schema$GoogleType__Expr { - /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. - */ - description?: string | null; - /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. - */ - expression?: string | null; - /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. - */ - location?: string | null; - /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. - */ - title?: string | null; - } - - export class Resource$Projects { - context: APIRequestContext; - brokers: Resource$Projects$Brokers; - constructor(context: APIRequestContext) { - this.context = context; - this.brokers = new Resource$Projects$Brokers(this.context); - } - } - - export class Resource$Projects$Brokers { - context: APIRequestContext; - instances: Resource$Projects$Brokers$Instances; - v2: Resource$Projects$Brokers$V2; - constructor(context: APIRequestContext) { - this.context = context; - this.instances = new Resource$Projects$Brokers$Instances(this.context); - this.v2 = new Resource$Projects$Brokers$V2(this.context); - } - - /** - * servicebroker.projects.brokers.create - * @desc CreateBroker creates a Broker. - * @alias servicebroker.projects.brokers.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.parent The project in which to create broker. - * @param {().GoogleCloudServicebrokerV1beta1__Broker} params.requestBody Request 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$Brokers$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Projects$Brokers$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Broker - > - ): void; - create( - params: Params$Resource$Projects$Brokers$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Broker - > - ): void; - create( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Broker - > - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Create - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Broker - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/brokers').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * servicebroker.projects.brokers.delete - * @desc DeleteBroker deletes a Broker. - * @alias servicebroker.projects.brokers.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The broker 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$Brokers$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Projects$Brokers$Delete, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Projects$Brokers$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Delete - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * servicebroker.projects.brokers.list - * @desc ListBrokers lists brokers. - * @alias servicebroker.projects.brokers.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) - * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers`. - * @param {object} [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$Brokers$List, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - >; - list( - params: Params$Resource$Projects$Brokers$List, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - > - ): void; - list( - params: Params$Resource$Projects$Brokers$List, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$List - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/brokers').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ListBrokersResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The project in which to create broker. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudServicebrokerV1beta1__Broker; - } - export interface Params$Resource$Projects$Brokers$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The broker to delete. - */ - name?: string; - } - export interface Params$Resource$Projects$Brokers$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) - */ - pageSize?: number; - /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers`. - */ - parent?: string; - } - - export class Resource$Projects$Brokers$Instances { - context: APIRequestContext; - bindings: Resource$Projects$Brokers$Instances$Bindings; - constructor(context: APIRequestContext) { - this.context = context; - this.bindings = new Resource$Projects$Brokers$Instances$Bindings( - this.context - ); - } - - /** - * servicebroker.projects.brokers.instances.get - * @desc Gets the given service instance from the system. The API call accepts both OSB style API and standard google style API resource path. i.e. both `projects/x/brokers/x/instances/x` and `projects/x/brokers/x/v2/service_instances/x` are acceptable paths. - * @alias servicebroker.projects.brokers.instances.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Brokers$Instances$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Brokers$Instances$Get, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > - ): void; - get( - params: Params$Resource$Projects$Brokers$Instances$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > - ): void; - get( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Instances$Get - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Instances$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Instances$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.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< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.instances.getLast_operation - * @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled. - * @alias servicebroker.projects.brokers.instances.getLast_operation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`. - * @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value. - * @param {string=} params.planId Plan id. - * @param {string=} params.serviceId Service 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 - */ - getLast_operation( - params?: Params$Resource$Projects$Brokers$Instances$Getlast_operation, - options?: MethodOptions - ): GaxiosPromise; - getLast_operation( - params: Params$Resource$Projects$Brokers$Instances$Getlast_operation, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - params: Params$Resource$Projects$Brokers$Instances$Getlast_operation, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Instances$Getlast_operation - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Instances$Getlast_operation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Instances$Getlast_operation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}/last_operation').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.instances.list - * @desc Lists all the instances in the brokers This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL. - * @alias servicebroker.projects.brokers.instances.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) - * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_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$Brokers$Instances$List, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - >; - list( - params: Params$Resource$Projects$Brokers$Instances$List, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - > - ): void; - list( - params: Params$Resource$Projects$Brokers$Instances$List, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Instances$List - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Instances$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Instances$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/instances').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ListServiceInstancesResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$Instances$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - */ - name?: string; - } - export interface Params$Resource$Projects$Brokers$Instances$Getlast_operation - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`. - */ - name?: string; - /** - * If `operation` was returned during mutation operation, this field must be populated with the provided value. - */ - operation?: string; - /** - * Plan id. - */ - planId?: string; - /** - * Service id. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$Instances$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) - */ - pageSize?: number; - /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - } - - export class Resource$Projects$Brokers$Instances$Bindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.projects.brokers.instances.bindings.getLast_operation - * @desc Returns the state of the last operation for the binding. Only last (or current) operation can be polled. - * @alias servicebroker.projects.brokers.instances.bindings.getLast_operation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. - * @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value. - * @param {string=} params.planId Plan id. - * @param {string=} params.serviceId Service 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 - */ - getLast_operation( - params?: Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation, - options?: MethodOptions - ): GaxiosPromise; - getLast_operation( - params: Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - params: Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}/last_operation').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.instances.bindings.list - * @desc Lists all the bindings in the instance. - * @alias servicebroker.projects.brokers.instances.bindings.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) - * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - list( - params?: Params$Resource$Projects$Brokers$Instances$Bindings$List, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - >; - list( - params: Params$Resource$Projects$Brokers$Instances$Bindings$List, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - > - ): void; - list( - params: Params$Resource$Projects$Brokers$Instances$Bindings$List, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$Instances$Bindings$List - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$Instances$Bindings$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$Instances$Bindings$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/bindings').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ListBindingsResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$Instances$Bindings$Getlast_operation - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. - */ - name?: string; - /** - * If `operation` was returned during mutation operation, this field must be populated with the provided value. - */ - operation?: string; - /** - * Plan id. - */ - planId?: string; - /** - * Service id. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$Instances$Bindings$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. Acceptable values are 0 to 200, inclusive. (Default: 100) - */ - pageSize?: number; - /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - */ - parent?: string; - } - - export class Resource$Projects$Brokers$V2 { - context: APIRequestContext; - catalog: Resource$Projects$Brokers$V2$Catalog; - service_instances: Resource$Projects$Brokers$V2$Service_instances; - constructor(context: APIRequestContext) { - this.context = context; - this.catalog = new Resource$Projects$Brokers$V2$Catalog(this.context); - this.service_instances = new Resource$Projects$Brokers$V2$Service_instances( - this.context - ); - } - } - - export class Resource$Projects$Brokers$V2$Catalog { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.projects.brokers.v2.catalog.list - * @desc Lists all the Services registered with this broker for consumption for given service registry broker, which contains an set of services. Note, that Service producer API is separate from Broker API. - * @alias servicebroker.projects.brokers.v2.catalog.list - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.pageSize Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. - * @param {string=} params.pageToken Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_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$Brokers$V2$Catalog$List, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - >; - list( - params: Params$Resource$Projects$Brokers$V2$Catalog$List, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - > - ): void; - list( - params: Params$Resource$Projects$Brokers$V2$Catalog$List, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - > - ): void; - list( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - > - ): void; - list( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Catalog$List - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Catalog$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Catalog$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+parent}/v2/catalog').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ListCatalogResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$V2$Catalog$List - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Specifies the number of results to return per page. If there are fewer elements than the specified number, returns all elements. Optional. If unset or 0, all the results will be returned. - */ - pageSize?: number; - /** - * Specifies a page token to use. Set `pageToken` to a `nextPageToken` returned by a previous list request to get the next page of results. - */ - pageToken?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - } - - export class Resource$Projects$Brokers$V2$Service_instances { - context: APIRequestContext; - service_bindings: Resource$Projects$Brokers$V2$Service_instances$Service_bindings; - constructor(context: APIRequestContext) { - this.context = context; - this.service_bindings = new Resource$Projects$Brokers$V2$Service_instances$Service_bindings( - this.context - ); - } - - /** - * servicebroker.projects.brokers.v2.service_instances.create - * @desc Provisions a service instance. If `request.accepts_incomplete` is false and Broker cannot execute request synchronously HTTP 422 error will be returned along with FAILED_PRECONDITION status. If `request.accepts_incomplete` is true and the Broker decides to execute resource asynchronously then HTTP 202 response code will be returned and a valid polling operation in the response will be included. If Broker executes the request synchronously and it succeeds HTTP 201 response will be furnished. If identical instance exists, then HTTP 200 response will be returned. If an instance with identical ID but mismatching parameters exists, then HTTP 409 status code will be returned. - * @alias servicebroker.projects.brokers.v2.service_instances.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous. - * @param {string} params.instance_id The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - * @param {string} params.parent Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - * @param {().GoogleCloudServicebrokerV1beta1__ServiceInstance} params.requestBody Request 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$Brokers$V2$Service_instances$Create, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - >; - create( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Create, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - > - ): void; - create( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - > - ): void; - create( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - > - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Create - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+parent}/v2/service_instances/{+instance_id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['parent', 'instance_id'], - pathParams: ['instance_id', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__CreateServiceInstanceResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.delete - * @desc Deprovisions a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If service instance does not exist HTTP 410 status will be returned. - * @alias servicebroker.projects.brokers.v2.service_instances.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. - * @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - * @param {string=} params.planId The plan id of the service instance. - * @param {string=} params.serviceId The service id of the service instance. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - >; - delete( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - > - ): void; - delete( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Delete, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - > - ): void; - delete( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - > - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Delete - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__DeleteServiceInstanceResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.get - * @desc Gets the given service instance from the system. The API call accepts both OSB style API and standard google style API resource path. i.e. both `projects/x/brokers/x/instances/x` and `projects/x/brokers/x/v2/service_instances/x` are acceptable paths. - * @alias servicebroker.projects.brokers.v2.service_instances.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - get( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Get, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > - ): void; - get( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > - ): void; - get( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Get - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.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< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.getLast_operation - * @desc Returns the state of the last operation for the service instance. Only last (or current) operation can be polled. - * @alias servicebroker.projects.brokers.v2.service_instances.getLast_operation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`. - * @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value. - * @param {string=} params.planId Plan id. - * @param {string=} params.serviceId Service 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 - */ - getLast_operation( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, - options?: MethodOptions - ): GaxiosPromise; - getLast_operation( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}/last_operation').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.patch - * @desc Updates an existing service instance. See CreateServiceInstance for possible response codes. - * @alias servicebroker.projects.brokers.v2.service_instances.patch - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. - * @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. - * @param {().GoogleCloudServicebrokerV1beta1__ServiceInstance} params.requestBody Request 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$Brokers$V2$Service_instances$Patch, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - >; - patch( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - > - ): void; - patch( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Patch, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - > - ): void; - patch( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - > - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Patch - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.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< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__UpdateServiceInstanceResponse - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous. - */ - acceptsIncomplete?: boolean; - /** - * The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - instance_id?: string; - /** - * Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * See CreateServiceInstanceRequest for details. - */ - acceptsIncomplete?: boolean; - /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - */ - name?: string; - /** - * The plan id of the service instance. - */ - planId?: string; - /** - * The service id of the service instance. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The resource name of the instance to return. Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + `v2/service_instances/[INSTANCE_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. - */ - name?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Getlast_operation - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ `service_instances/[INSTANCE_ID]`. - */ - name?: string; - /** - * If `operation` was returned during mutation operation, this field must be populated with the provided value. - */ - operation?: string; - /** - * Plan id. - */ - planId?: string; - /** - * Service id. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Patch - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * See CreateServiceInstanceRequest for details. - */ - acceptsIncomplete?: boolean; - /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudServicebrokerV1beta1__ServiceInstance; - } - - export class Resource$Projects$Brokers$V2$Service_instances$Service_bindings { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.projects.brokers.v2.service_instances.service_bindings.create - * @desc CreateBinding generates a service binding to an existing service instance. See ProviServiceInstance for async operation details. - * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.create - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. - * @param {string} params.binding_id The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - * @param {string} params.parent The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. - * @param {().GoogleCloudServicebrokerV1beta1__Binding} params.requestBody Request 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$Brokers$V2$Service_instances$Service_bindings$Create, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - >; - create( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - > - ): void; - create( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - > - ): void; - create( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - > - ): void; - create( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: ( - rootUrl + '/v1beta1/{+parent}/service_bindings/{+binding_id}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PUT', - }, - options - ), - params, - requiredParams: ['parent', 'binding_id'], - pathParams: ['binding_id', 'parent'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__CreateBindingResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.service_bindings.delete - * @desc Unbinds from a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If binding does not exist HTTP 410 status will be returned. - * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {boolean=} params.acceptsIncomplete See CreateServiceInstanceRequest for details. - * @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `v2/service_instances/[INSTANCE_ID]/service_bindings/[BINDING_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `/instances/[INSTANCE_ID]/bindings/[BINDING_ID]`. - * @param {string=} params.planId The plan id of the service instance. - * @param {string=} params.serviceId Additional query parameter hints. The service id of the service instance. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - >; - delete( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - > - ): void; - delete( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - > - ): void; - delete( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - > - ): void; - delete( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__DeleteBindingResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.service_bindings.get - * @desc GetBinding returns the binding information. - * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.get - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_bindings`. - * @param {string=} params.planId Plan id. - * @param {string=} params.serviceId Service 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$Brokers$V2$Service_instances$Service_bindings$Get, - options?: MethodOptions - ): GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - >; - get( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - > - ): void; - get( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - > - ): void; - get( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - > - ): void; - get( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - > - ): void | GaxiosPromise< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - > { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.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< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - >(parameters, callback); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__GetBindingResponse - >(parameters); - } - } - - /** - * servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation - * @desc Returns the state of the last operation for the binding. Only last (or current) operation can be polled. - * @alias servicebroker.projects.brokers.v2.service_instances.service_bindings.getLast_operation - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. - * @param {string=} params.operation If `operation` was returned during mutation operation, this field must be populated with the provided value. - * @param {string=} params.planId Plan id. - * @param {string=} params.serviceId Service 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 - */ - getLast_operation( - params?: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, - options?: MethodOptions - ): GaxiosPromise; - getLast_operation( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, - options: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - params: Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation, - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - callback: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void; - getLast_operation( - paramsOrCallback?: - | Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >, - callback?: BodyResponseCallback< - Schema$GoogleCloudServicebrokerV1beta1__Operation - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}/last_operation').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest< - Schema$GoogleCloudServicebrokerV1beta1__Operation - >(parameters); - } - } - } - - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Create - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * See CreateServiceInstanceRequest for details. - */ - acceptsIncomplete?: boolean; - /** - * The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required. - */ - binding_id?: string; - /** - * The GCP container. Must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleCloudServicebrokerV1beta1__Binding; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * See CreateServiceInstanceRequest for details. - */ - acceptsIncomplete?: boolean; - /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `v2/service_instances/[INSTANCE_ID]/service_bindings/[BINDING_ID]` or `projects/[PROJECT_ID]/brokers/[BROKER_ID]/` `/instances/[INSTANCE_ID]/bindings/[BINDING_ID]`. - */ - name?: string; - /** - * The plan id of the service instance. - */ - planId?: string; - /** - * Additional query parameter hints. The service id of the service instance. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Get - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_bindings`. - */ - name?: string; - /** - * Plan id. - */ - planId?: string; - /** - * Service id. - */ - serviceId?: string; - } - export interface Params$Resource$Projects$Brokers$V2$Service_instances$Service_bindings$Getlast_operation - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Name must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. - */ - name?: string; - /** - * If `operation` was returned during mutation operation, this field must be populated with the provided value. - */ - operation?: string; - /** - * Plan id. - */ - planId?: string; - /** - * Service id. - */ - serviceId?: string; - } - - export class Resource$V1beta1 { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * servicebroker.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 servicebroker.getIamPolicy - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {integer=} params.options.requestedPolicyVersion Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - * @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$V1beta1$Getiampolicy, - options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$V1beta1$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getIamPolicy( - params: Params$Resource$V1beta1$Getiampolicy, - callback: BodyResponseCallback - ): void; - getIamPolicy( - callback: BodyResponseCallback - ): void; - getIamPolicy( - paramsOrCallback?: - | Params$Resource$V1beta1$Getiampolicy - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$V1beta1$Getiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1beta1$Getiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+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); - } - } - - /** - * servicebroker.setIamPolicy - * @desc Sets the access control policy on the specified resource. Replaces any existing policy. Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED - * @alias servicebroker.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 {().GoogleIamV1__SetIamPolicyRequest} params.requestBody Request 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$V1beta1$Setiampolicy, - options?: MethodOptions - ): GaxiosPromise; - setIamPolicy( - params: Params$Resource$V1beta1$Setiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - setIamPolicy( - params: Params$Resource$V1beta1$Setiampolicy, - callback: BodyResponseCallback - ): void; - setIamPolicy( - callback: BodyResponseCallback - ): void; - setIamPolicy( - paramsOrCallback?: - | Params$Resource$V1beta1$Setiampolicy - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$V1beta1$Setiampolicy; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1beta1$Setiampolicy; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:setIamPolicy').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest(parameters, callback); - } else { - return createAPIRequest(parameters); - } - } - - /** - * servicebroker.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 servicebroker.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 {().GoogleIamV1__TestIamPermissionsRequest} params.requestBody Request 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$V1beta1$Testiampermissions, - options?: MethodOptions - ): GaxiosPromise; - testIamPermissions( - params: Params$Resource$V1beta1$Testiampermissions, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - params: Params$Resource$V1beta1$Testiampermissions, - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - callback: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void; - testIamPermissions( - paramsOrCallback?: - | Params$Resource$V1beta1$Testiampermissions - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | BodyResponseCallback, - callback?: BodyResponseCallback< - Schema$GoogleIamV1__TestIamPermissionsResponse - > - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$V1beta1$Testiampermissions; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$V1beta1$Testiampermissions; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://servicebroker.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+resource}:testIamPermissions').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['resource'], - pathParams: ['resource'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$V1beta1$Getiampolicy - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. - */ - 'options.requestedPolicyVersion'?: number; - /** - * REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. - */ - resource?: string; - } - export interface Params$Resource$V1beta1$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$GoogleIamV1__SetIamPolicyRequest; - } - export interface Params$Resource$V1beta1$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$GoogleIamV1__TestIamPermissionsRequest; - } -} diff --git a/src/apis/serviceconsumermanagement/v1.ts b/src/apis/serviceconsumermanagement/v1.ts index 6f508419cb..e5b9b4a0c9 100644 --- a/src/apis/serviceconsumermanagement/v1.ts +++ b/src/apis/serviceconsumermanagement/v1.ts @@ -251,6 +251,10 @@ export namespace serviceconsumermanagement_v1 { * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string | null; + /** + * Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token + */ + jwtLocations?: Schema$JwtLocation[]; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -279,15 +283,15 @@ export namespace serviceconsumermanagement_v1 { */ export interface Schema$BackendRule { /** - * The address of the API backend. + * The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version. */ address?: string | null; /** - * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. + * The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */ deadline?: number | null; /** - * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + * When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. */ disableAuth?: boolean | null; /** @@ -303,6 +307,10 @@ export namespace serviceconsumermanagement_v1 { */ operationDeadline?: number | null; pathTranslation?: string | null; + /** + * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. + */ + protocol?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ @@ -626,6 +634,10 @@ export namespace serviceconsumermanagement_v1 { * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; + /** + * When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method. + */ + allowHalfDuplex?: boolean | null; /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ @@ -663,6 +675,23 @@ export namespace serviceconsumermanagement_v1 { */ selector?: string | null; } + /** + * Specifies a location to extract JWT from an API request. + */ + export interface Schema$JwtLocation { + /** + * Specifies HTTP header name to extract JWT token. + */ + header?: string | null; + /** + * Specifies URL query parameter name to extract JWT token. + */ + query?: string | null; + /** + * The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end. + */ + valuePrefix?: string | null; + } /** * A description of a label. */ @@ -1216,6 +1245,23 @@ export namespace serviceconsumermanagement_v1 { */ tenantProjectRoles?: string[] | null; } + /** + * The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: "projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used as the identity of Cloud XXX to access resources" + */ + export interface Schema$ServiceIdentity { + /** + * Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes. + */ + description?: string | null; + /** + * Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes. + */ + displayName?: string | null; + /** + * A service account project that hosts the service accounts. An example name would be: `projects/123456789` + */ + serviceAccountParent?: string | null; + } /** * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ @@ -1424,6 +1470,10 @@ export namespace serviceconsumermanagement_v1 { * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; + /** + * The configuration of a per-product per-project service identity. + */ + serviceIdentity?: Schema$ServiceIdentity; } /** * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true @@ -1491,7 +1541,7 @@ export namespace serviceconsumermanagement_v1 { */ 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. + * 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} | null; /** diff --git a/src/apis/servicecontrol/v1.ts b/src/apis/servicecontrol/v1.ts index b63066ebcd..1577433ca7 100644 --- a/src/apis/servicecontrol/v1.ts +++ b/src/apis/servicecontrol/v1.ts @@ -159,6 +159,36 @@ export namespace servicecontrol_v1 { */ serviceConfigId?: string | null; } + /** + * A set of attributes, each in the format `[KEY]:[VALUE]`. + */ + export interface Schema$Attributes { + /** + * The set of attributes. Each attribute's key can be up to 128 bytes long. The value can be a string up to 256 bytes, a signed 64-bit integer, or the Boolean values `true` and `false`. For example: "/instance_id": "my-instance" "/http/user_agent": "" "/http/request_bytes": 300 "abc.com/myattribute": true + */ + attributeMap?: {[key: string]: Schema$AttributeValue} | null; + /** + * The number of attributes that were discarded. Attributes can be discarded because their keys are too long or because there are too many attributes. If this value is 0 then all attributes are valid. + */ + droppedAttributesCount?: number | null; + } + /** + * The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute. + */ + export interface Schema$AttributeValue { + /** + * A Boolean value represented by `true` or `false`. + */ + boolValue?: boolean | null; + /** + * A 64-bit signed integer. + */ + intValue?: string | null; + /** + * A string up to 256 bytes long. + */ + stringValue?: Schema$TruncatableString; + } /** * Common audit log format for Google Cloud Platform API operations. */ @@ -789,6 +819,10 @@ export namespace servicecontrol_v1 { * Required. Start time of the operation. */ startTime?: string | null; + /** + * Unimplemented. A list of Cloud Trace spans. The span names shall contain the id of the destination project which can be either the produce or the consumer project. + */ + traceSpans?: Schema$TraceSpan[]; /** * User defined labels for the resource that this operation is associated with. Only a combination of 1000 user labels per consumer project are allowed. */ @@ -1094,11 +1128,11 @@ export namespace servicecontrol_v1 { thirdPartyPrincipal?: Schema$ThirdPartyPrincipal; } /** - * The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation. It contains the name of a span with format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] + * The context of a span, attached to Exemplars in Distribution values during aggregation. It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] */ export interface Schema$SpanContext { /** - * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. + * The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] `[TRACE_ID]` is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. `[SPAN_ID]` is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. */ spanName?: string | null; } @@ -1128,6 +1162,68 @@ export namespace servicecontrol_v1 { */ thirdPartyClaims?: {[key: string]: any} | null; } + /** + * A span represents a single operation within a trace. Spans can be nested to form a trace tree. Often, a trace contains a root span that describes the end-to-end latency, and one or more subspans for its sub-operations. A trace can also contain multiple root spans, or none at all. Spans do not need to be contiguous&mdash;there may be gaps or overlaps between spans in a trace. + */ + export interface Schema$TraceSpan { + /** + * A set of attributes on the span. You can have up to 32 attributes per span. + */ + attributes?: Schema$Attributes; + /** + * An optional number of child spans that were generated while this span was active. If set, allows implementation to detect missing child spans. + */ + childSpanCount?: number | null; + /** + * A description of the span's operation (up to 128 bytes). Stackdriver Trace displays the description in the Google Cloud Platform Console. For example, the display name can be a qualified method name or a file name and a line number where the operation is called. A best practice is to use the same display name within an application and at the same call point. This makes it easier to correlate spans in different traces. + */ + displayName?: Schema$TruncatableString; + /** + * The end time of the span. On the client side, this is the time kept by the local machine where the span execution ends. On the server side, this is the time when the server application handler stops running. + */ + endTime?: string | null; + /** + * The resource name of the span in the following format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array. + */ + name?: string | null; + /** + * The [SPAN_ID] of this span's parent span. If this is a root span, then this field must be empty. + */ + parentSpanId?: string | null; + /** + * (Optional) Set this parameter to indicate whether this span is in the same process as its parent. If you do not set this parameter, Stackdriver Trace is unable to take advantage of this helpful information. + */ + sameProcessAsParentSpan?: boolean | null; + /** + * The [SPAN_ID] portion of the span's resource name. + */ + spanId?: string | null; + /** + * Distinguishes between spans generated in a particular context. For example, two spans with the same name may be distinguished using `CLIENT` (caller) and `SERVER` (callee) to identify an RPC call. + */ + spanKind?: string | null; + /** + * The start time of the span. On the client side, this is the time kept by the local machine where the span execution starts. On the server side, this is the time when the server's application handler starts running. + */ + startTime?: string | null; + /** + * An optional final status for this span. + */ + status?: Schema$Status; + } + /** + * Represents a string that might be shortened to a specified length. + */ + export interface Schema$TruncatableString { + /** + * The number of bytes removed from the original string. If this value is 0, then the string was not shortened. + */ + truncatedByteCount?: number | null; + /** + * The shortened string. For example, if the original string is 500 bytes long and the limit of the string is 128 bytes, then `value` contains the first 128 bytes of the 500-byte string. Truncation always happens on a UTF8 character boundary. If there are multi-byte characters in the string, then the length of the shortened string might be less than the size limit. + */ + value?: string | null; + } export class Resource$Services { context: APIRequestContext; diff --git a/src/apis/servicemanagement/v1.ts b/src/apis/servicemanagement/v1.ts index 161fbc6581..3893913139 100644 --- a/src/apis/servicemanagement/v1.ts +++ b/src/apis/servicemanagement/v1.ts @@ -271,15 +271,15 @@ export namespace servicemanagement_v1 { */ export interface Schema$BackendRule { /** - * The address of the API backend. + * The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version. */ address?: string | null; /** - * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. + * The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */ deadline?: number | null; /** - * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + * When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. */ disableAuth?: boolean | null; /** @@ -295,6 +295,10 @@ export namespace servicemanagement_v1 { */ operationDeadline?: number | null; pathTranslation?: string | null; + /** + * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. + */ + protocol?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ @@ -655,23 +659,23 @@ export namespace servicemanagement_v1 { options?: Schema$Option[]; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -806,6 +810,10 @@ export namespace servicemanagement_v1 { * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; + /** + * When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method. + */ + allowHalfDuplex?: boolean | null; /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ @@ -1462,6 +1470,23 @@ export namespace servicemanagement_v1 { */ usage?: Schema$Usage; } + /** + * The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: "projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used as the identity of Cloud XXX to access resources" + */ + export interface Schema$ServiceIdentity { + /** + * Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes. + */ + description?: string | null; + /** + * Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes. + */ + displayName?: string | null; + /** + * A service account project that hosts the service accounts. An example name would be: `projects/123456789` + */ + serviceAccountParent?: string | null; + } /** * Request message for `SetIamPolicy` method. */ @@ -1665,6 +1690,10 @@ export namespace servicemanagement_v1 { * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; + /** + * The configuration of a per-product per-project service identity. + */ + serviceIdentity?: Schema$ServiceIdentity; } /** * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true diff --git a/src/apis/servicenetworking/v1.ts b/src/apis/servicenetworking/v1.ts index 62ae43d731..faf811e6ff 100644 --- a/src/apis/servicenetworking/v1.ts +++ b/src/apis/servicenetworking/v1.ts @@ -137,6 +137,10 @@ export namespace servicenetworking_v1 { * Required. The prefix length of the subnet's IP address range. Use CIDR range notation, such as `30` to provision a subnet with an `x.x.x.x/30` CIDR range. The IP address range is drawn from a pool of available ranges in the service consumer's allocated range. */ ipPrefixLength?: number | null; + /** + * Optional. The private IPv6 google access type for the VMs in this subnet. For information about the access types that can be set using this field, see [subnetwork](/compute/docs/reference/rest/v1/subnetworks) in the Compute API documentation. + */ + privateIpv6GoogleAccess?: string | null; /** * Required. The name of a [region](/compute/docs/regions-zones) for the subnet, such `europe-west1`. */ @@ -245,6 +249,10 @@ export namespace servicenetworking_v1 { * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string | null; + /** + * Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token + */ + jwtLocations?: Schema$JwtLocation[]; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -273,15 +281,15 @@ export namespace servicenetworking_v1 { */ export interface Schema$BackendRule { /** - * The address of the API backend. + * The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version. */ address?: string | null; /** - * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. + * The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */ deadline?: number | null; /** - * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + * When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. */ disableAuth?: boolean | null; /** @@ -297,6 +305,10 @@ export namespace servicenetworking_v1 { */ operationDeadline?: number | null; pathTranslation?: string | null; + /** + * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. + */ + protocol?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ @@ -662,6 +674,10 @@ export namespace servicenetworking_v1 { * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; + /** + * When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method. + */ + allowHalfDuplex?: boolean | null; /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ @@ -699,6 +715,23 @@ export namespace servicenetworking_v1 { */ selector?: string | null; } + /** + * Specifies a location to extract JWT from an API request. + */ + export interface Schema$JwtLocation { + /** + * Specifies HTTP header name to extract JWT token. + */ + header?: string | null; + /** + * Specifies URL query parameter name to extract JWT token. + */ + query?: string | null; + /** + * The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end. + */ + valuePrefix?: string | null; + } /** * A description of a label. */ @@ -1108,6 +1141,10 @@ export namespace servicenetworking_v1 { * Required. The size of the desired subnet. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine if one of the allocated ranges has enough free space for a subnet of the requested size. */ ipPrefixLength?: number | null; + /** + * Optional. DO NOT USE - Under development. The size of the desired secondary ranges for the subnet. Use usual CIDR range notation. For example, '30' to find unused x.x.x.x/30 CIDR range. The goal is to determine that the allocated ranges have enough free space for all the requested secondary ranges. + */ + secondaryRangeIpPrefixLengths?: number[] | null; } /** * Request to search for an unused range within allocated ranges. @@ -1235,6 +1272,23 @@ export namespace servicenetworking_v1 { */ usage?: Schema$Usage; } + /** + * The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: "projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used as the identity of Cloud XXX to access resources" + */ + export interface Schema$ServiceIdentity { + /** + * Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes. + */ + description?: string | null; + /** + * Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes. + */ + displayName?: string | null; + /** + * A service account project that hosts the service accounts. An example name would be: `projects/123456789` + */ + serviceAccountParent?: string | null; + } /** * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ @@ -1375,6 +1429,10 @@ export namespace servicenetworking_v1 { * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; + /** + * The configuration of a per-product per-project service identity. + */ + serviceIdentity?: Schema$ServiceIdentity; } /** * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true diff --git a/src/apis/servicenetworking/v1beta.ts b/src/apis/servicenetworking/v1beta.ts index c4f5c2be46..cf10fb70c9 100644 --- a/src/apis/servicenetworking/v1beta.ts +++ b/src/apis/servicenetworking/v1beta.ts @@ -245,6 +245,10 @@ export namespace servicenetworking_v1beta { * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string | null; + /** + * Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token + */ + jwtLocations?: Schema$JwtLocation[]; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -273,15 +277,15 @@ export namespace servicenetworking_v1beta { */ export interface Schema$BackendRule { /** - * The address of the API backend. + * The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version. */ address?: string | null; /** - * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. + * The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */ deadline?: number | null; /** - * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + * When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. */ disableAuth?: boolean | null; /** @@ -297,6 +301,10 @@ export namespace servicenetworking_v1beta { */ operationDeadline?: number | null; pathTranslation?: string | null; + /** + * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. + */ + protocol?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ @@ -627,6 +635,10 @@ export namespace servicenetworking_v1beta { * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; + /** + * When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method. + */ + allowHalfDuplex?: boolean | null; /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ @@ -664,6 +676,23 @@ export namespace servicenetworking_v1beta { */ selector?: string | null; } + /** + * Specifies a location to extract JWT from an API request. + */ + export interface Schema$JwtLocation { + /** + * Specifies HTTP header name to extract JWT token. + */ + header?: string | null; + /** + * Specifies URL query parameter name to extract JWT token. + */ + query?: string | null; + /** + * The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end. + */ + valuePrefix?: string | null; + } /** * A description of a label. */ @@ -1178,6 +1207,23 @@ export namespace servicenetworking_v1beta { */ usage?: Schema$Usage; } + /** + * The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: "projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used as the identity of Cloud XXX to access resources" + */ + export interface Schema$ServiceIdentity { + /** + * Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes. + */ + description?: string | null; + /** + * Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes. + */ + displayName?: string | null; + /** + * A service account project that hosts the service accounts. An example name would be: `projects/123456789` + */ + serviceAccountParent?: string | null; + } /** * `SourceContext` represents information about the source of a protobuf element, like the file in which it is defined. */ @@ -1318,6 +1364,10 @@ export namespace servicenetworking_v1beta { * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; + /** + * The configuration of a per-product per-project service identity. + */ + serviceIdentity?: Schema$ServiceIdentity; } /** * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true diff --git a/src/apis/serviceusage/v1.ts b/src/apis/serviceusage/v1.ts index de5af5c859..05b96f1653 100644 --- a/src/apis/serviceusage/v1.ts +++ b/src/apis/serviceusage/v1.ts @@ -208,6 +208,10 @@ export namespace serviceusage_v1 { * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string | null; + /** + * Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token + */ + jwtLocations?: Schema$JwtLocation[]; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -236,15 +240,15 @@ export namespace serviceusage_v1 { */ export interface Schema$BackendRule { /** - * The address of the API backend. + * The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version. */ address?: string | null; /** - * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. + * The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */ deadline?: number | null; /** - * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + * When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. */ disableAuth?: boolean | null; /** @@ -260,6 +264,10 @@ export namespace serviceusage_v1 { */ operationDeadline?: number | null; pathTranslation?: string | null; + /** + * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. + */ + protocol?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ @@ -745,6 +753,23 @@ export namespace serviceusage_v1 { */ usage?: Schema$Usage; } + /** + * The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: "projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used as the identity of Cloud XXX to access resources" + */ + export interface Schema$GoogleApiServiceIdentity { + /** + * Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes. + */ + description?: string | null; + /** + * Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes. + */ + displayName?: string | null; + /** + * A service account project that hosts the service accounts. An example name would be: `projects/123456789` + */ + serviceAccountParent?: string | null; + } /** * Response message for getting service identity. */ @@ -859,6 +884,10 @@ export namespace serviceusage_v1 { * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; + /** + * When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method. + */ + allowHalfDuplex?: boolean | null; /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ @@ -896,6 +925,23 @@ export namespace serviceusage_v1 { */ selector?: string | null; } + /** + * Specifies a location to extract JWT from an API request. + */ + export interface Schema$JwtLocation { + /** + * Specifies HTTP header name to extract JWT token. + */ + header?: string | null; + /** + * Specifies URL query parameter name to extract JWT token. + */ + query?: string | null; + /** + * The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end. + */ + valuePrefix?: string | null; + } /** * A description of a label. */ @@ -1446,6 +1492,10 @@ export namespace serviceusage_v1 { * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; + /** + * The configuration of a per-product per-project service identity. + */ + serviceIdentity?: Schema$GoogleApiServiceIdentity; } /** * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true diff --git a/src/apis/serviceusage/v1beta1.ts b/src/apis/serviceusage/v1beta1.ts index 01bb2ae356..9c8b6077a4 100644 --- a/src/apis/serviceusage/v1beta1.ts +++ b/src/apis/serviceusage/v1beta1.ts @@ -208,6 +208,10 @@ export namespace serviceusage_v1beta1 { * URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of the issuer. - can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs */ jwksUri?: string | null; + /** + * Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token + */ + jwtLocations?: Schema$JwtLocation[]; } /** * User-defined authentication requirements, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32). @@ -236,15 +240,15 @@ export namespace serviceusage_v1beta1 { */ export interface Schema$BackendRule { /** - * The address of the API backend. + * The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version. */ address?: string | null; /** - * The number of seconds to wait for a response from a request. The default deadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds. + * The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */ deadline?: number | null; /** - * When disable_auth is false, a JWT ID token will be generated with the value from BackendRule.address as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend. When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. + * When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header. */ disableAuth?: boolean | null; /** @@ -260,6 +264,10 @@ export namespace serviceusage_v1beta1 { */ operationDeadline?: number | null; pathTranslation?: string | null; + /** + * The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance. Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values. + */ + protocol?: string | null; /** * Selects the methods to which this rule applies. Refer to selector for syntax details. */ @@ -736,6 +744,23 @@ export namespace serviceusage_v1beta1 { */ usage?: Schema$Usage; } + /** + * The per-product per-project service identity for a service. Use this field to configure per-product per-project service identity. Example of a service identity configuration. usage: service_identity: - service_account_parent: "projects/123456789" display_name: "Cloud XXX Service Agent" description: "Used as the identity of Cloud XXX to access resources" + */ + export interface Schema$GoogleApiServiceIdentity { + /** + * Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes. + */ + description?: string | null; + /** + * Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes. + */ + displayName?: string | null; + /** + * A service account project that hosts the service accounts. An example name would be: `projects/123456789` + */ + serviceAccountParent?: string | null; + } /** * Response message for getting service identity. */ @@ -850,6 +875,10 @@ export namespace serviceusage_v1beta1 { * Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */ additionalBindings?: Schema$HttpRule[]; + /** + * When this flag is set to true, HTTP requests will be allowed to invoke a half-duplex streaming method. + */ + allowHalfDuplex?: boolean | null; /** * The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type. */ @@ -887,6 +916,23 @@ export namespace serviceusage_v1beta1 { */ selector?: string | null; } + /** + * Specifies a location to extract JWT from an API request. + */ + export interface Schema$JwtLocation { + /** + * Specifies HTTP header name to extract JWT token. + */ + header?: string | null; + /** + * Specifies URL query parameter name to extract JWT token. + */ + query?: string | null; + /** + * The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end. + */ + valuePrefix?: string | null; + } /** * A description of a label. */ @@ -1495,6 +1541,10 @@ export namespace serviceusage_v1beta1 { * A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */ rules?: Schema$UsageRule[]; + /** + * The configuration of a per-product per-project service identity. + */ + serviceIdentity?: Schema$GoogleApiServiceIdentity; } /** * Usage configuration rules for the service. NOTE: Under development. Use this rule to configure unregistered calls for the service. Unregistered calls are calls that do not contain consumer project identity. (Example: calls that do not contain an API key). By default, API methods do not allow unregistered calls, and each method call must be identified by a consumer project identity. Use this rule to allow/disallow unregistered calls. Example of an API that wants to allow unregistered calls for entire service. usage: rules: - selector: "*" allow_unregistered_calls: true Example of a method that wants to allow unregistered calls. usage: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allow_unregistered_calls: true diff --git a/src/apis/sheets/v4.ts b/src/apis/sheets/v4.ts index 8986521d19..47f639e1b6 100644 --- a/src/apis/sheets/v4.ts +++ b/src/apis/sheets/v4.ts @@ -379,17 +379,33 @@ export namespace sheets_v4 { */ firstBandColor?: Schema$Color; /** - * The color of the last row or column. If this field is not set, the last row or column will be filled with either first_band_color or second_band_color, depending on the color of the previous row or column. + * The first color that is alternating. (Required) If first_band_color is also set, this field takes precedence. + */ + firstBandColorStyle?: Schema$ColorStyle; + /** + * The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. */ footerColor?: Schema$Color; /** - * The color of the first row or column. If this field is set, the first row or column will be filled with this color and the colors will alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column will be filled with first_band_color and the colors will proceed to alternate as they normally would. + * The color of the last row or column. If this field is not set, the last row or column is filled with either first_band_color or second_band_color, depending on the color of the previous row or column. If footer_color is also set, this field takes precedence. + */ + footerColorStyle?: Schema$ColorStyle; + /** + * The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would. */ headerColor?: Schema$Color; + /** + * The color of the first row or column. If this field is set, the first row or column is filled with this color and the colors alternate between first_band_color and second_band_color starting from the second row or column. Otherwise, the first row or column is filled with first_band_color and the colors proceed to alternate as they normally would. If header_color is also set, this field takes precedence. + */ + headerColorStyle?: Schema$ColorStyle; /** * The second color that is alternating. (Required) */ secondBandColor?: Schema$Color; + /** + * The second color that is alternating. (Required) If second_band_color is also set, this field takes precedence. + */ + secondBandColorStyle?: Schema$ColorStyle; } /** * Formatting options for baseline value. @@ -407,6 +423,10 @@ export namespace sheets_v4 { * Color to be used, in case baseline value represents a negative change for key value. This field is optional. */ negativeColor?: Schema$Color; + /** + * Color to be used, in case baseline value represents a negative change for key value. This field is optional. If negative_color is also set, this field takes precedence. + */ + negativeColorStyle?: Schema$ColorStyle; /** * Specifies the horizontal text positioning of baseline value. This field is optional. If not specified, default positioning is used. */ @@ -415,6 +435,10 @@ export namespace sheets_v4 { * Color to be used, in case baseline value represents a positive change for key value. This field is optional. */ positiveColor?: Schema$Color; + /** + * Color to be used, in case baseline value represents a positive change for key value. This field is optional. If positive_color is also set, this field takes precedence. + */ + positiveColorStyle?: Schema$ColorStyle; /** * Text formatting options for baseline value. */ @@ -463,9 +487,13 @@ export namespace sheets_v4 { */ export interface Schema$BasicChartSeries { /** - * The color for elements (i.e. bars, lines, points) associated with this series. If empty, a default color is used. + * The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. */ color?: Schema$Color; + /** + * The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. If color is also set, this field takes precedence. + */ + colorStyle?: Schema$ColorStyle; /** * The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. */ @@ -563,7 +591,7 @@ export namespace sheets_v4 { */ export interface Schema$BatchClearValuesByDataFilterResponse { /** - * The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.) + * The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits. */ clearedRanges?: string[] | null; /** @@ -585,7 +613,7 @@ export namespace sheets_v4 { */ export interface Schema$BatchClearValuesResponse { /** - * The ranges that were cleared, in A1 notation. (If the requests were for an unbounded range or a ranger larger than the bounds of the sheet, this will be the actual ranges that were cleared, bounded to the sheet's limits.) + * The ranges that were cleared, in A1 notation. If the requests are for an unbounded range or a ranger larger than the bounds of the sheet, this is the actual ranges that were cleared, bounded to the sheet's limits. */ clearedRanges?: string[] | null; /** @@ -598,7 +626,7 @@ export namespace sheets_v4 { */ export interface Schema$BatchGetValuesByDataFilterRequest { /** - * The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters will be included in the response. + * The data filters used to match the ranges of values to retrieve. Ranges that match any of the specified data filters are included in the response. */ dataFilters?: Schema$DataFilter[]; /** @@ -606,7 +634,7 @@ export namespace sheets_v4 { */ dateTimeRenderOption?: string | null; /** - * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. + * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */ majorDimension?: string | null; /** @@ -683,11 +711,11 @@ export namespace sheets_v4 { */ export interface Schema$BatchUpdateValuesByDataFilterRequest { /** - * The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values will be applied to all of those ranges. + * The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges. */ data?: Schema$DataFilterValueRange[]; /** - * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). + * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */ includeValuesInResponse?: boolean | null; /** @@ -741,7 +769,7 @@ export namespace sheets_v4 { */ data?: Schema$ValueRange[]; /** - * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses will contain the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). + * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The `updatedData` field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */ includeValuesInResponse?: boolean | null; /** @@ -820,6 +848,10 @@ export namespace sheets_v4 { * The color of the border. */ color?: Schema$Color; + /** + * The color of the border. If color is also set, this field takes precedence. + */ + colorStyle?: Schema$ColorStyle; /** * The style of the border. */ @@ -858,6 +890,10 @@ export namespace sheets_v4 { * The bubble border color. */ bubbleBorderColor?: Schema$Color; + /** + * The bubble border color. If bubble_border_color is also set, this field takes precedence. + */ + bubbleBorderColorStyle?: Schema$ColorStyle; /** * The data containing the bubble labels. These do not need to be unique. */ @@ -1008,6 +1044,10 @@ export namespace sheets_v4 { * The background color of the cell. */ backgroundColor?: Schema$Color; + /** + * The background color of the cell. If background_color is also set, this field takes precedence. + */ + backgroundColorStyle?: Schema$ColorStyle; /** * The borders of the cell. */ @@ -1109,6 +1149,10 @@ export namespace sheets_v4 { * The background color of the entire chart. Not applicable to Org charts. */ backgroundColor?: Schema$Color; + /** + * The background color of the entire chart. Not applicable to Org charts. If background_color is also set, this field takes precedence. + */ + backgroundColorStyle?: Schema$ColorStyle; /** * A basic chart specification, can be one of many kinds of charts. See BasicChartType for the list of all charts this supports. */ @@ -1367,7 +1411,7 @@ export namespace sheets_v4 { */ majorDimension?: string | null; /** - * The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request will fail. If the provided values are less than the matched ranges only the specified values will be written, existing values in the matched ranges will remain unaffected. + * The data to be written. If the provided values exceed any of the ranges matched by the data filter then the request fails. If the provided values are less than the matched ranges only the specified values are written, existing values in the matched ranges remain unaffected. */ values?: any[][] | null; } @@ -1845,13 +1889,21 @@ export namespace sheets_v4 { */ hiddenValues?: string[] | null; /** - * The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with all other filter criteria. Requests to set this field will fail with a 400 error if any other filter criteria field is set. + * The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with all other filter criteria. Requests to set this field fail with a 400 error if any other filter criteria field is set. */ visibleBackgroundColor?: Schema$Color; /** - * The text color to filter by; only cells with this text color are shown. Mutually exclusive with all other filter criteria. Requests to set this field will fail with a 400 error if any other filter criteria field is set. + * The background fill color to filter by; only cells with this fill color are shown. Mutually exclusive with all other filter criteria. Requests to set this field fail with a 400 error if any other filter criteria field is set. If visible_background_color is also set, this field takes precedence. + */ + visibleBackgroundColorStyle?: Schema$ColorStyle; + /** + * The text color to filter by; only cells with this text color are shown. Mutually exclusive with all other filter criteria. Requests to set this field fail with a 400 error if any other filter criteria field is set. */ visibleForegroundColor?: Schema$Color; + /** + * The text color to filter by; only cells with this text color are shown. Mutually exclusive with all other filter criteria. Requests to set this field fail with a 400 error if any other filter criteria field is set. If visible_foreground_color is also set, this field takes precedence. + */ + visibleForegroundColorStyle?: Schema$ColorStyle; } /** * A filter view. @@ -2128,6 +2180,10 @@ export namespace sheets_v4 { * The color of the column representing this series in each bucket. This field is optional. */ barColor?: Schema$Color; + /** + * The color of the column representing this series in each bucket. This field is optional. If bar_color is also set, this field takes precedence. + */ + barColorStyle?: Schema$ColorStyle; /** * The data for this histogram series. */ @@ -2167,6 +2223,10 @@ export namespace sheets_v4 { * The color this interpolation point should use. */ color?: Schema$Color; + /** + * The color this interpolation point should use. If color is also set, this field takes precedence. + */ + colorStyle?: Schema$ColorStyle; /** * How the value should be interpreted. */ @@ -2331,6 +2391,10 @@ export namespace sheets_v4 { * The color of the org chart nodes. */ nodeColor?: Schema$Color; + /** + * The color of the org chart nodes. If node_color is also set, this field takes precedence. + */ + nodeColorStyle?: Schema$ColorStyle; /** * The size of the org chart nodes. */ @@ -2343,6 +2407,10 @@ export namespace sheets_v4 { * The color of the selected org chart nodes. */ selectedNodeColor?: Schema$Color; + /** + * The color of the selected org chart nodes. If selected_node_color is also set, this field takes precedence. + */ + selectedNodeColorStyle?: Schema$ColorStyle; /** * The data containing the tooltip for the corresponding node. A blank value results in no tooltip being displayed for the node. This field is optional. */ @@ -3031,7 +3099,7 @@ export namespace sheets_v4 { */ export interface Schema$SearchDeveloperMetadataRequest { /** - * The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters will be included in the response. + * The data filters describing the criteria used to determine which DeveloperMetadata entries to return. DeveloperMetadata matching any of the specified filters are included in the response. */ dataFilters?: Schema$DataFilter[]; } @@ -3155,6 +3223,10 @@ export namespace sheets_v4 { * The color of the tab in the UI. */ tabColor?: Schema$Color; + /** + * The color of the tab in the UI. If tab_color is also set, this field takes precedence. + */ + tabColorStyle?: Schema$ColorStyle; /** * The name of the sheet. */ @@ -3189,6 +3261,10 @@ export namespace sheets_v4 { * The background color of the slicer. */ backgroundColor?: Schema$Color; + /** + * The background color of the slicer. If background_color is also set, this field takes precedence. + */ + backgroundColorStyle?: Schema$ColorStyle; /** * The column index in the data table on which the filter is applied to. */ @@ -3232,17 +3308,25 @@ export namespace sheets_v4 { */ export interface Schema$SortSpec { /** - * The background fill color to sort by. Mutually exclusive with sorting by text color. Requests to set this field will fail with a 400 error if foreground color is also set. + * The background fill color to sort by. Mutually exclusive with sorting by text color. Requests to set this field fail with a 400 error if foreground color is also set. */ backgroundColor?: Schema$Color; + /** + * The background fill color to sort by. Mutually exclusive with sorting by text color. Requests to set this field fail with a 400 error if foreground color is also set. If background_color is also set, this field takes precedence. + */ + backgroundColorStyle?: Schema$ColorStyle; /** * The dimension the sort should be applied to. */ dimensionIndex?: number | null; /** - * The text color to sort by. Mutually exclusive with sorting by background fill color. Requests to set this field will fail with a 400 error if background color is also set. + * The text color to sort by. Mutually exclusive with sorting by background fill color. Requests to set this field fail with a 400 error if background color is also set. */ foregroundColor?: Schema$Color; + /** + * The text color to sort by. Mutually exclusive with sorting by background fill color. Requests to set this field fail with a 400 error if background color is also set. If foreground_color is also set, this field takes precedence. + */ + foregroundColorStyle?: Schema$ColorStyle; /** * The order data should be sorted. */ @@ -3307,7 +3391,7 @@ export namespace sheets_v4 { */ defaultFormat?: Schema$CellFormat; /** - * Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references will result in calculation errors. + * Determines whether and how circular references are resolved with iterative calculation. Absence of this field means that circular references result in calculation errors. */ iterativeCalculationSettings?: Schema$IterativeCalculationSettings; /** @@ -3336,7 +3420,7 @@ export namespace sheets_v4 { */ primaryFontFamily?: string | null; /** - * The spreadsheet theme color pairs. For update users need to give all pairs of theme colors. + * The spreadsheet theme color pairs. To update you must provide all theme color pairs. */ themeColors?: Schema$ThemeColorPair[]; } @@ -3360,6 +3444,10 @@ export namespace sheets_v4 { * The foreground color of the text. */ foregroundColor?: Schema$Color; + /** + * The foreground color of the text. If foreground_color is also set, this field takes precedence. + */ + foregroundColorStyle?: Schema$ColorStyle; /** * True if the text is italicized. */ @@ -3446,18 +3534,34 @@ export namespace sheets_v4 { * The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified. */ maxValueColor?: Schema$Color; + /** + * The background color for cells with a color value greater than or equal to maxValue. Defaults to #109618 if not specified. If max_value_color is also set, this field takes precedence. + */ + maxValueColorStyle?: Schema$ColorStyle; /** * The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified. */ midValueColor?: Schema$Color; + /** + * The background color for cells with a color value at the midpoint between minValue and maxValue. Defaults to #efe6dc if not specified. If mid_value_color is also set, this field takes precedence. + */ + midValueColorStyle?: Schema$ColorStyle; /** * The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified. */ minValueColor?: Schema$Color; + /** + * The background color for cells with a color value less than or equal to minValue. Defaults to #dc3912 if not specified. If min_value_color is also set, this field takes precedence. + */ + minValueColorStyle?: Schema$ColorStyle; /** * The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. */ noDataColor?: Schema$Color; + /** + * The background color for cells that have no color data associated with them. Defaults to #000000 if not specified. If no_data_color is also set, this field takes precedence. + */ + noDataColorStyle?: Schema$ColorStyle; } /** * A <a href="/chart/interactive/docs/gallery/treemap">Treemap chart</a>. @@ -3475,6 +3579,10 @@ export namespace sheets_v4 { * The background color for header cells. */ headerColor?: Schema$Color; + /** + * The background color for header cells. If header_color is also set, this field takes precedence. + */ + headerColorStyle?: Schema$ColorStyle; /** * True to hide tooltips. */ @@ -3908,6 +4016,10 @@ export namespace sheets_v4 { * The color of the column. */ color?: Schema$Color; + /** + * The color of the column. If color is also set, this field takes precedence. + */ + colorStyle?: Schema$ColorStyle; /** * The label of the column's legend. */ @@ -5144,7 +5256,7 @@ export namespace sheets_v4 { * @param {object} params Parameters for request * @param {boolean=} params.includeValuesInResponse Determines if the update response should include the values of the cells that were appended. By default, responses do not include the updated values. * @param {string=} params.insertDataOption How the input data should be inserted. - * @param {string} params.range The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table. + * @param {string} params.range The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table. * @param {string=} params.responseDateTimeRenderOption Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. * @param {string=} params.responseValueRenderOption Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. * @param {string} params.spreadsheetId The ID of the spreadsheet to update. @@ -5565,7 +5677,7 @@ export namespace sheets_v4 { * * @param {object} params Parameters for request * @param {string=} params.dateTimeRenderOption How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. - * @param {string=} params.majorDimension The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. + * @param {string=} params.majorDimension The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. * @param {string=} params.ranges The A1 notation of the values to retrieve. * @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve data from. * @param {string=} params.valueRenderOption How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. @@ -6276,7 +6388,7 @@ export namespace sheets_v4 { * * @param {object} params Parameters for request * @param {string=} params.dateTimeRenderOption How dates, times, and durations should be represented in the output. This is ignored if value_render_option is FORMATTED_VALUE. The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. - * @param {string=} params.majorDimension The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. + * @param {string=} params.majorDimension The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. * @param {string} params.range The A1 notation of the values to retrieve. * @param {string} params.spreadsheetId The ID of the spreadsheet to retrieve data from. * @param {string=} params.valueRenderOption How values should be represented in the output. The default render option is ValueRenderOption.FORMATTED_VALUE. @@ -6410,7 +6522,7 @@ export namespace sheets_v4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {boolean=} params.includeValuesInResponse Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). + * @param {boolean=} params.includeValuesInResponse Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). * @param {string} params.range The A1 notation of the values to update. * @param {string=} params.responseDateTimeRenderOption Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. * @param {string=} params.responseValueRenderOption Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. @@ -6501,7 +6613,7 @@ export namespace sheets_v4 { */ insertDataOption?: string; /** - * The A1 notation of a range to search for a logical table of data. Values will be appended after the last row of the table. + * The A1 notation of a range to search for a logical table of data. Values are appended after the last row of the table. */ range?: string; /** @@ -6572,7 +6684,7 @@ export namespace sheets_v4 { */ dateTimeRenderOption?: string; /** - * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. + * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */ majorDimension?: string; /** @@ -6672,7 +6784,7 @@ export namespace sheets_v4 { */ dateTimeRenderOption?: string; /** - * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return `[[1,3],[2,4]]`. + * The major dimension that results should use. For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. */ majorDimension?: string; /** @@ -6696,7 +6808,7 @@ export namespace sheets_v4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than than the range actually written, the response will include all values in the requested range (excluding trailing empty rows and columns). + * Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range (excluding trailing empty rows and columns). */ includeValuesInResponse?: boolean; /** diff --git a/src/apis/sourcerepo/v1.ts b/src/apis/sourcerepo/v1.ts index 0d1df782bb..fb1363b048 100644 --- a/src/apis/sourcerepo/v1.ts +++ b/src/apis/sourcerepo/v1.ts @@ -163,23 +163,23 @@ export namespace sourcerepo_v1 { */ export interface Schema$Empty {} /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index eeb07c47a2..06adea2bf1 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -289,7 +289,7 @@ export namespace spanner_v1 { */ export interface Schema$Delete { /** - * Required. The primary keys of the rows within table to delete. Delete is idempotent. The transaction will succeed even if some or all rows do not exist. + * Required. The primary keys of the rows within table to delete. The primary keys must be specified in the order in which they appear in the `PRIMARY KEY()` clause of the table's equivalent DDL statement (the DDL statement used to create the table). Delete is idempotent. The transaction will succeed even if some or all rows do not exist. */ keySet?: Schema$KeySet; /** @@ -369,23 +369,23 @@ export namespace spanner_v1 { transaction?: Schema$TransactionSelector; } /** - * Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" + * Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. */ export interface Schema$Expr { /** - * An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */ description?: string | null; /** - * Textual representation of an expression in Common Expression Language syntax. The application context of the containing message determines which well-known feature set of CEL is supported. + * Textual representation of an expression in Common Expression Language syntax. */ expression?: string | null; /** - * An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */ location?: string | null; /** - * An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. + * Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */ title?: string | null; } @@ -4220,7 +4220,7 @@ export namespace spanner_v1 { /** * spanner.projects.instances.databases.sessions.create - * @desc Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. + * @desc Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. * @alias spanner.projects.instances.databases.sessions.create * @memberOf! () * diff --git a/src/apis/sql/v1beta4.ts b/src/apis/sql/v1beta4.ts index 2075c6257d..0f762a227d 100644 --- a/src/apis/sql/v1beta4.ts +++ b/src/apis/sql/v1beta4.ts @@ -185,6 +185,10 @@ export namespace sql_v1beta4 { * Location of the backup */ location?: string | null; + /** + * Reserved for future use. + */ + pointInTimeRecoveryEnabled?: boolean | null; /** * Reserved for future use. */ @@ -313,6 +317,10 @@ export namespace sql_v1beta4 { * Reserved for future use. */ pitrTimestampMs?: string | null; + /** + * Reserved for future use. + */ + pointInTime?: string | null; } /** * Represents a SQL database on the Cloud SQL instance. @@ -638,6 +646,10 @@ export namespace sql_v1beta4 { * A flag resource. */ export interface Schema$Flag { + /** + * Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values. + */ + allowedIntValues?: string[] | null; /** * For <code>STRING</code> flags, a list of strings that the value can be set to. */ @@ -789,7 +801,7 @@ export namespace sql_v1beta4 { */ nextPageToken?: string | null; /** - * List of warnings that ocurred while handling the request. + * List of warnings that occurred while handling the request. */ warnings?: Schema$ApiWarning[]; } @@ -975,6 +987,10 @@ export namespace sql_v1beta4 { * PEM representation of the slave's private key. The corresponsing public key is encoded in the client's certificate. */ clientKey?: string | null; + /** + * The dump file to create the Cloud SQL replica. + */ + dumpFilePath?: string | null; /** * The host and port of the on-premises instance in host:port format */ @@ -983,6 +999,14 @@ export namespace sql_v1beta4 { * This is always <code>sql#onPremisesConfiguration</code>. */ kind?: string | null; + /** + * The password for connecting to on-premises instance. + */ + password?: string | null; + /** + * The username for connecting to on-premises instance. + */ + username?: string | null; } /** * An Operation resource.&nbsp;For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. @@ -1116,7 +1140,7 @@ export namespace sql_v1beta4 { */ rescheduleType?: string | null; /** - * Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME. + * Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in <a href="https://tools.ietf.org/html/rfc3339">RFC 3339</a> format, for example <code>2012-11-15T16:19:00.094Z</code>. */ scheduleTime?: string | null; } @@ -1239,6 +1263,23 @@ export namespace sql_v1beta4 { */ userLabels?: {[key: string]: string} | null; } + /** + * External master migration setting error. + */ + export interface Schema$SqlExternalSyncSettingError { + /** + * Additional information about the error encountered. + */ + detail?: string | null; + /** + * This is always <code>sql#migrationSettingError</code>. + */ + kind?: string | null; + /** + * Identifies the specific error that occurred. + */ + type?: string | null; + } /** * Reschedule options for maintenance windows. */ @@ -1248,6 +1289,19 @@ export namespace sql_v1beta4 { */ reschedule?: Schema$Reschedule; } + /** + * Instance verify external sync settings response. + */ + export interface Schema$SqlInstancesVerifyExternalSyncSettingsResponse { + /** + * List of migration violations. + */ + errors?: Schema$SqlExternalSyncSettingError[]; + /** + * This is always <code>sql#migrationSettingErrorList</code>. + */ + kind?: string | null; + } /** * Any scheduled maintenancce for this instance. */ @@ -1275,6 +1329,19 @@ export namespace sql_v1beta4 { */ recoveryModel?: string | null; } + /** + * Represents a Sql Server user on the Cloud SQL instance. + */ + export interface Schema$SqlServerUserDetails { + /** + * If the user has been disabled + */ + disabled?: boolean | null; + /** + * The server roles for this user + */ + serverRoles?: string[] | null; + } /** * SslCerts Resource */ @@ -1464,6 +1531,7 @@ export namespace sql_v1beta4 { * The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for <code>update</code> since it is already specified on the URL. */ project?: string | null; + sqlserverUserDetails?: Schema$SqlServerUserDetails; } /** * User list response. @@ -2210,7 +2278,7 @@ export namespace sql_v1beta4 { /** * sql.databases.patch - * @desc Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics. + * @desc Partially updates a resource containing information about a database inside a Cloud SQL instance. This method supports patch semantics. * @alias sql.databases.patch * @memberOf! () * @@ -3291,9 +3359,10 @@ export namespace sql_v1beta4 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter An expression for filtering the results of the request, such as by name or label. + * @param {string=} params.filter A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. * @param {integer=} params.maxResults The maximum number of results to return per response. * @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view. + * @param {string=} params.parent The parent, which owns this collection of database instances. Format: projects/{project}/locations/{location} * @param {string} params.project Project ID of the project for which to list Cloud SQL instances. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. @@ -4134,7 +4203,7 @@ export namespace sql_v1beta4 { /** * sql.instances.update - * @desc Updates settings of a Cloud SQL instance. + * @desc Updates settings of a Cloud SQL instance. * @alias sql.instances.update * @memberOf! () * @@ -4415,7 +4484,7 @@ export namespace sql_v1beta4 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * An expression for filtering the results of the request, such as by name or label. + * A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. */ filter?: string; /** @@ -4426,6 +4495,10 @@ export namespace sql_v1beta4 { * A previously-returned page token representing part of the larger set of results to view. */ pageToken?: string; + /** + * The parent, which owns this collection of database instances. Format: projects/{project}/locations/{location} + */ + parent?: string; /** * Project ID of the project for which to list Cloud SQL instances. */ @@ -4976,6 +5049,186 @@ export namespace sql_v1beta4 { return createAPIRequest(parameters); } } + + /** + * sql.projects.instances.startExternalSync + * @desc Start External master migration. + * @alias sql.projects.instances.startExternalSync + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string=} params.parent The parent resource where Cloud SQL starts this database instance external sync. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project ID of the project that contains the first generation instance. + * @param {string=} params.syncMode External sync mode + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + startExternalSync( + params?: Params$Resource$Projects$Instances$Startexternalsync, + options?: MethodOptions + ): GaxiosPromise; + startExternalSync( + params: Params$Resource$Projects$Instances$Startexternalsync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startExternalSync( + params: Params$Resource$Projects$Instances$Startexternalsync, + callback: BodyResponseCallback + ): void; + startExternalSync(callback: BodyResponseCallback): void; + startExternalSync( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Startexternalsync + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Startexternalsync; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Startexternalsync; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/startExternalSync' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.projects.instances.verifyExternalSyncSettings + * @desc Verify External master external sync settings. + * @alias sql.projects.instances.verifyExternalSyncSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string=} params.parent The parent resource where Cloud SQL verifies this database instance external sync settings. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string} params.project Project ID of the project that contains the instance. + * @param {string=} params.syncMode External sync mode + * @param {boolean=} params.verifyConnectionOnly Flag to enable verifying connection only + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + verifyExternalSyncSettings( + params?: Params$Resource$Projects$Instances$Verifyexternalsyncsettings, + options?: MethodOptions + ): GaxiosPromise; + verifyExternalSyncSettings( + params: Params$Resource$Projects$Instances$Verifyexternalsyncsettings, + options: + | MethodOptions + | BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + >, + callback: BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > + ): void; + verifyExternalSyncSettings( + params: Params$Resource$Projects$Instances$Verifyexternalsyncsettings, + callback: BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > + ): void; + verifyExternalSyncSettings( + callback: BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > + ): void; + verifyExternalSyncSettings( + paramsOrCallback?: + | Params$Resource$Projects$Instances$Verifyexternalsyncsettings + | BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + >, + callback?: BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > + ): void | GaxiosPromise< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Instances$Verifyexternalsyncsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Instances$Verifyexternalsyncsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/sql/v1beta4/projects/{project}/instances/{instance}/verifyExternalSyncSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + >(parameters); + } + } } export interface Params$Resource$Projects$Instances$Reschedulemaintenance @@ -5003,6 +5256,58 @@ export namespace sql_v1beta4 { */ requestBody?: Schema$SqlInstancesRescheduleMaintenanceRequestBody; } + export interface Params$Resource$Projects$Instances$Startexternalsync + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL starts this database instance external sync. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * ID of the project that contains the first generation instance. + */ + project?: string; + /** + * External sync mode + */ + syncMode?: string; + } + export interface Params$Resource$Projects$Instances$Verifyexternalsyncsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL verifies this database instance external sync settings. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * External sync mode + */ + syncMode?: string; + /** + * Flag to enable verifying connection only + */ + verifyConnectionOnly?: boolean; + } export class Resource$Projects$Locations { context: APIRequestContext; @@ -5096,6 +5401,185 @@ export namespace sql_v1beta4 { return createAPIRequest(parameters); } } + + /** + * sql.projects.locations.instances.startExternalSync + * @desc Start External master migration. + * @alias sql.projects.locations.instances.startExternalSync + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.parent The parent resource where Cloud SQL starts this database instance external sync. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string=} params.project ID of the project that contains the first generation instance. + * @param {string=} params.syncMode External sync mode + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + startExternalSync( + params?: Params$Resource$Projects$Locations$Instances$Startexternalsync, + options?: MethodOptions + ): GaxiosPromise; + startExternalSync( + params: Params$Resource$Projects$Locations$Instances$Startexternalsync, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startExternalSync( + params: Params$Resource$Projects$Locations$Instances$Startexternalsync, + callback: BodyResponseCallback + ): void; + startExternalSync(callback: BodyResponseCallback): void; + startExternalSync( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Startexternalsync + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Startexternalsync; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Startexternalsync; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/sql/v1beta4/{+parent}/startExternalSync').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * sql.projects.locations.instances.verifyExternalSyncSettings + * @desc Verify External master external sync settings. + * @alias sql.projects.locations.instances.verifyExternalSyncSettings + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.instance Cloud SQL instance ID. This does not include the project ID. + * @param {string} params.parent The parent resource where Cloud SQL verifies this database instance external sync settings. Format: projects/{project}/locations/{location}/instances/{instance} + * @param {string=} params.project Project ID of the project that contains the instance. + * @param {string=} params.syncMode External sync mode + * @param {boolean=} params.verifyConnectionOnly Flag to enable verifying connection only + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + verifyExternalSyncSettings( + params?: Params$Resource$Projects$Locations$Instances$Verifyexternalsyncsettings, + options?: MethodOptions + ): GaxiosPromise; + verifyExternalSyncSettings( + params: Params$Resource$Projects$Locations$Instances$Verifyexternalsyncsettings, + options: + | MethodOptions + | BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + >, + callback: BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > + ): void; + verifyExternalSyncSettings( + params: Params$Resource$Projects$Locations$Instances$Verifyexternalsyncsettings, + callback: BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > + ): void; + verifyExternalSyncSettings( + callback: BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > + ): void; + verifyExternalSyncSettings( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Verifyexternalsyncsettings + | BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + >, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + >, + callback?: BodyResponseCallback< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > + ): void | GaxiosPromise< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + > { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Verifyexternalsyncsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Verifyexternalsyncsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/sql/v1beta4/{+parent}/verifyExternalSyncSettings' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback + ); + } else { + return createAPIRequest< + Schema$SqlInstancesVerifyExternalSyncSettingsResponse + >(parameters); + } + } } export interface Params$Resource$Projects$Locations$Instances$Reschedulemaintenance @@ -5123,6 +5607,58 @@ export namespace sql_v1beta4 { */ requestBody?: Schema$SqlInstancesRescheduleMaintenanceRequestBody; } + export interface Params$Resource$Projects$Locations$Instances$Startexternalsync + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL starts this database instance external sync. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * ID of the project that contains the first generation instance. + */ + project?: string; + /** + * External sync mode + */ + syncMode?: string; + } + export interface Params$Resource$Projects$Locations$Instances$Verifyexternalsyncsettings + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * The parent resource where Cloud SQL verifies this database instance external sync settings. Format: projects/{project}/locations/{location}/instances/{instance} + */ + parent?: string; + /** + * Project ID of the project that contains the instance. + */ + project?: string; + /** + * External sync mode + */ + syncMode?: string; + /** + * Flag to enable verifying connection only + */ + verifyConnectionOnly?: boolean; + } export class Resource$Sslcerts { context: APIRequestContext; diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index 16ec8296d0..a55411124e 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -963,7 +963,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1090,7 +1090,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1217,7 +1217,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1341,7 +1341,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1474,7 +1474,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1607,7 +1607,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1884,7 +1884,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2006,7 +2006,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2127,7 +2127,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2254,7 +2254,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2387,7 +2387,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2508,7 +2508,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2637,7 +2637,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2763,7 +2763,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2893,7 +2893,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3025,7 +3025,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3462,7 +3462,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3603,7 +3603,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3729,7 +3729,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3855,7 +3855,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3981,7 +3981,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4114,7 +4114,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4246,7 +4246,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4533,7 +4533,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4659,7 +4659,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4786,7 +4786,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -4907,7 +4907,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5135,7 +5135,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5267,7 +5267,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5399,7 +5399,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5529,7 +5529,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5668,7 +5668,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -5806,7 +5806,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -6145,7 +6145,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -6296,7 +6296,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -6432,7 +6432,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -6566,7 +6566,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -6692,7 +6692,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -6836,7 +6836,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -6979,7 +6979,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -7116,7 +7116,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -7272,7 +7272,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -7414,7 +7414,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -7550,7 +7550,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -7689,7 +7689,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -7820,7 +7820,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -8647,7 +8647,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -8766,7 +8766,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -8890,7 +8890,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -9027,7 +9027,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -9157,7 +9157,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -9403,7 +9403,7 @@ export namespace storage_v1 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { diff --git a/src/apis/storage/v1beta2.ts b/src/apis/storage/v1beta2.ts index d95bf1605b..57e2880ef5 100644 --- a/src/apis/storage/v1beta2.ts +++ b/src/apis/storage/v1beta2.ts @@ -588,7 +588,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -663,7 +663,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -738,7 +738,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -814,7 +814,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -890,7 +890,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -966,7 +966,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1150,7 +1150,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1224,7 +1224,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1297,7 +1297,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1368,7 +1368,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1440,7 +1440,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1515,7 +1515,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1735,7 +1735,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1827,7 +1827,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1901,7 +1901,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -1975,7 +1975,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2052,7 +2052,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2127,7 +2127,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2202,7 +2202,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2395,7 +2395,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2471,7 +2471,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2547,7 +2547,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2624,7 +2624,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2701,7 +2701,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -2778,7 +2778,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3011,7 +3011,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3096,7 +3096,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3183,7 +3183,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3261,7 +3261,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3342,7 +3342,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3423,7 +3423,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3502,7 +3502,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3581,7 +3581,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { @@ -3659,7 +3659,7 @@ export namespace storage_v1beta2 { options = {}; } - const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const rootUrl = options.rootUrl || 'https://storage.googleapis.com/'; const parameters = { options: Object.assign( { diff --git a/src/apis/storagetransfer/v1.ts b/src/apis/storagetransfer/v1.ts index 86ea209634..5cabca285a 100644 --- a/src/apis/storagetransfer/v1.ts +++ b/src/apis/storagetransfer/v1.ts @@ -122,7 +122,7 @@ export namespace storagetransfer_v1 { } /** - * AWS access key (see [AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). + * AWS access key (see [AWS Security Credentials](https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)). */ export interface Schema$AwsAccessKey { /** @@ -143,7 +143,7 @@ export namespace storagetransfer_v1 { */ awsAccessKey?: Schema$AwsAccessKey; /** - * Required. S3 Bucket name (see [Creating a bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). + * Required. S3 Bucket name (see [Creating a bucket](https://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)). */ bucketName?: string | null; } @@ -199,7 +199,7 @@ export namespace storagetransfer_v1 { errorLogEntries?: Schema$ErrorLogEntry[]; } /** - * In a GcsData resource, an object's name is the Cloud Storage object's name and its `lastModificationTime` refers to the object's updated time, which changes when the content or the metadata of the object is updated. + * In a GcsData resource, an object's name is the Cloud Storage object's name and its "last modification time" refers to the object's `updated` property of Cloud Storage objects, which changes when the content or the metadata of the object is updated. */ export interface Schema$GcsData { /** @@ -217,7 +217,7 @@ export namespace storagetransfer_v1 { accountEmail?: string | null; } /** - * An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * HTTP URL - The location of the object. * Length - The size of the object in bytes. * MD5 - The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage/transfer/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/<URL-path>` is transferred to a data sink, the name of the object at the data sink is `<hostname>/<URL-path>`. * If the specified size of an object does not match the actual size of the object fetched, the object will not be transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. For more information, see [Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5) * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * [ObjectConditions](#ObjectConditions) have no effect when filtering objects to transfer. + * An HttpData resource specifies a list of objects on the web to be transferred over HTTP. The information of the objects to be transferred is contained in a file referenced by a URL. The first line in the file must be `"TsvHttpData-1.0"`, which specifies the format of the file. Subsequent lines specify the information of the list of objects, one object per list entry. Each entry has the following tab-delimited fields: * **HTTP URL** — The location of the object. * **Length** — The size of the object in bytes. * **MD5** — The base64-encoded MD5 hash of the object. For an example of a valid TSV file, see [Transferring data from URLs](https://cloud.google.com/storage-transfer/docs/create-url-list). When transferring data based on a URL list, keep the following in mind: * When an object located at `http(s)://hostname:port/<URL-path>` is transferred to a data sink, the name of the object at the data sink is `<hostname>/<URL-path>`. * If the specified size of an object does not match the actual size of the object fetched, the object will not be transferred. * If the specified MD5 does not match the MD5 computed from the transferred bytes, the object transfer will fail. For more information, see [Generating MD5 hashes](https://cloud.google.com/storage-transfer/docs/create-url-list#md5) * Ensure that each URL you specify is publicly accessible. For example, in Cloud Storage you can [share an object publicly] (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get a link to it. * Storage Transfer Service obeys `robots.txt` rules and requires the source HTTP server to support `Range` requests and to return a `Content-Length` header in each response. * ObjectConditions have no effect when filtering objects to transfer. */ export interface Schema$HttpData { /** @@ -252,23 +252,23 @@ export namespace storagetransfer_v1 { transferJobs?: Schema$TransferJob[]; } /** - * Conditions that determine which objects will be transferred. Applies only to S3 and Cloud Storage objects. + * Conditions that determine which objects will be transferred. Applies only to S3 and Cloud Storage objects. The "last modification time" refers to the time of the last change to the object's content or metadata — specifically, this is the `updated` property of Cloud Storage objects and the `LastModified` field of S3 objects. */ export interface Schema$ObjectConditions { /** - * `excludePrefixes` must follow the requirements described for `includePrefixes`. The max size of `excludePrefixes` is 1000. + * `exclude_prefixes` must follow the requirements described for include_prefixes. The max size of `exclude_prefixes` is 1000. */ excludePrefixes?: string[] | null; /** - * If `includePrefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `includePrefixes` and that do not start with any of the `excludePrefixes`. If `includePrefixes` is not specified, all objects except those that have names starting with one of the `excludePrefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix and exclude-prefix must omit the leading slash. For example, to include the `requests.gz` object in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace, i.e., no include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace, i.e., no exclude-prefix may be a prefix of another exclude-prefix. * If `includePrefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `includePrefixes`. The max size of `includePrefixes` is 1000. + * If `include_prefixes` is specified, objects that satisfy the object conditions must have names that start with one of the `include_prefixes` and that do not start with any of the exclude_prefixes. If `include_prefixes` is not specified, all objects except those that have names starting with one of the `exclude_prefixes` must satisfy the object conditions. Requirements: * Each include-prefix and exclude-prefix can contain any sequence of Unicode characters, to a max length of 1024 bytes when UTF8-encoded, and must not contain Carriage Return or Line Feed characters. Wildcard matching and regular expression matching are not supported. * Each include-prefix and exclude-prefix must omit the leading slash. For example, to include the `requests.gz` object in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include prefix as `logs/y=2015/requests.gz`. * None of the include-prefix or the exclude-prefix values can be empty, if specified. * Each include-prefix must include a distinct portion of the object namespace. No include-prefix may be a prefix of another include-prefix. * Each exclude-prefix must exclude a distinct portion of the object namespace. No exclude-prefix may be a prefix of another exclude-prefix. * If `include_prefixes` is specified, then each exclude-prefix must start with the value of a path explicitly included by `include_prefixes`. The max size of `include_prefixes` is 1000. */ includePrefixes?: string[] | null; /** - * If specified, only objects with a `lastModificationTime` on or after `NOW` - `maxTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that, for each `TransferOperation` started by this `TransferJob`, `NOW` refers to the `start_time` of the 'TransferOperation`. Also, `lastModificationTime` refers to the time of the last change to the object's content or metadata - specifically, this would be the `updated` property of Cloud Storage objects and the `LastModified` field of S3 objects. + * If specified, only objects with a "last modification time" on or after `NOW` - `max_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred. For each TransferOperation started by this TransferJob, `NOW` refers to the start_time of the `TransferOperation`. */ maxTimeElapsedSinceLastModification?: string | null; /** - * If specified, only objects with a `lastModificationTime` before `NOW` - `minTimeElapsedSinceLastModification` and objects that don't have a `lastModificationTime` are transferred. Note that, for each `TransferOperation` started by this `TransferJob`, `NOW` refers to the `start_time` of the 'TransferOperation`. Also, `lastModificationTime` refers to the time of the last change to the object's content or metadata - specifically, this would be the `updated` property of Cloud Storage objects and the `LastModified` field of S3 objects. + * If specified, only objects with a "last modification time" before `NOW` - `min_time_elapsed_since_last_modification` and objects that don't have a "last modification time" are transferred. For each TransferOperation started by this TransferJob, `NOW` refers to the start_time of the `TransferOperation`. */ minTimeElapsedSinceLastModification?: string | null; } @@ -310,15 +310,15 @@ export namespace storagetransfer_v1 { */ export interface Schema$Schedule { /** - * The last day a transfer runs. Date boundaries are determined relative to UTC time. A job will run once per 24 hours within the following guidelines: * If `scheduleEndDate` and `scheduleStartDate` are the same and in the future relative to UTC, the transfer is executed only one time. * If `scheduleEndDate` is later than `scheduleStartDate` and `scheduleEndDate` is in the future relative to UTC, the job will run each day at `startTimeOfDay` through `scheduleEndDate`. + * The last day a transfer runs. Date boundaries are determined relative to UTC time. A job will run once per 24 hours within the following guidelines: * If `schedule_end_date` and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. * If `schedule_end_date` is later than `schedule_start_date` and `schedule_end_date` is in the future relative to UTC, the job will run each day at start_time_of_day through `schedule_end_date`. */ scheduleEndDate?: Schema$Date; /** - * Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If `scheduleStartDate` and `startTimeOfDay` are in the past relative to the job's creation time, the transfer starts the day after you schedule the transfer request. Note: When starting jobs at or near midnight UTC it is possible that a job will start later than expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then it will create a TransferJob with `scheduleStartDate` set to June 2 and a `startTimeOfDay` set to midnight UTC. The first scheduled TransferOperation will take place on June 3 at midnight UTC. + * Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If `schedule_start_date` and start_time_of_day are in the past relative to the job's creation time, the transfer starts the day after you schedule the transfer request. **Note:** When starting jobs at or near midnight UTC it is possible that a job will start later than expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then it will create a TransferJob with `schedule_start_date` set to June 2 and a `start_time_of_day` set to midnight UTC. The first scheduled TransferOperation will take place on June 3 at midnight UTC. */ scheduleStartDate?: Schema$Date; /** - * The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If `startTimeOfDay` is not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through `scheduleEndDate`. If `startTimeOfDay` is specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, through `scheduleEndDate`. + * The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time. If `start_time_of_day` is not specified: * One-time transfers run immediately. * Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date. If `start_time_of_day` is specified: * One-time transfers run at the specified time. * Recurring transfers run at the specified time each day, through `schedule_end_date`. */ startTimeOfDay?: Schema$TimeOfDay; } @@ -450,7 +450,7 @@ export namespace storagetransfer_v1 { */ lastModificationTime?: string | null; /** - * A globally unique name assigned by Storage Transfer Service when the job is created. This field should be left empty in requests to create a new transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` error. + * A unique name (within the transfer project) assigned when the job is created. If this field is left empty in a CreateTransferJobRequest, Storage Transfer Service will assign a unique name. Otherwise, the supplied name is used as the unique name for this job. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. Example of a valid format : `"transferJobs/[A-Za-z0-9-._~]*[A-Za-z0-9]$"` **Note:** If the supplied name is already in use, the creation request results in an ALREADY_EXISTS error and the transfer job will not be created. Invalid job names will return an INVALID_ARGUMENT error and the job will not be created. */ name?: string | null; /** @@ -462,7 +462,7 @@ export namespace storagetransfer_v1 { */ schedule?: Schema$Schedule; /** - * Status of the job. This value MUST be specified for `CreateTransferJobRequests`. NOTE: The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running, the status change would not affect the current operation. + * Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation. */ status?: string | null; /** @@ -516,11 +516,11 @@ export namespace storagetransfer_v1 { */ export interface Schema$TransferOptions { /** - * Whether objects should be deleted from the source after they are transferred to the sink. Note that this option and `deleteObjectsUniqueInSink` are mutually exclusive. + * Whether objects should be deleted from the source after they are transferred to the sink. **Note:** This option and delete_objects_unique_in_sink are mutually exclusive. */ deleteObjectsFromSourceAfterTransfer?: boolean | null; /** - * Whether objects that exist only in the sink should be deleted. Note that this option and `deleteObjectsFromSourceAfterTransfer` are mutually exclusive. + * Whether objects that exist only in the sink should be deleted. **Note:** This option and delete_objects_from_source_after_transfer are mutually exclusive. */ deleteObjectsUniqueInSink?: boolean | null; /** @@ -549,11 +549,11 @@ export namespace storagetransfer_v1 { */ httpDataSource?: Schema$HttpData; /** - * Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' `lastModificationTime` do not exclude objects in a data sink. + * Only objects that satisfy these object conditions are included in the set of data source and data sink objects. Object conditions based on objects' "last modification time" do not exclude objects in a data sink. */ objectConditions?: Schema$ObjectConditions; /** - * If the option `deleteObjectsUniqueInSink` is `true`, object conditions based on objects' `lastModificationTime` are ignored and do not exclude objects in a data source or a data sink. + * If the option delete_objects_unique_in_sink is `true`, object conditions based on objects' "last modification time" are ignored and do not exclude objects in a data source or a data sink. */ transferOptions?: Schema$TransferOptions; } @@ -566,11 +566,11 @@ export namespace storagetransfer_v1 { */ projectId?: string | null; /** - * Required. The job to update. `transferJob` is expected to specify only three fields: `description`, `transferSpec`, and `status`. An UpdateTransferJobRequest that specifies other fields will be rejected with an error `INVALID_ARGUMENT`. + * Required. The job to update. `transferJob` is expected to specify only three fields: description, transfer_spec, and status. An `UpdateTransferJobRequest` that specifies other fields will be rejected with the error INVALID_ARGUMENT. */ transferJob?: Schema$TransferJob; /** - * The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: `description`, `transferSpec`, and `status`. To update the `transferSpec` of the job, a complete transfer specification has to be provided. An incomplete specification which misses any required fields will be rejected with the error `INVALID_ARGUMENT`. + * The field mask of the fields in `transferJob` that are to be updated in this request. Fields in `transferJob` that can be updated are: description, transfer_spec, and status. To update the `transfer_spec` of the job, a complete transfer specification must be provided. An incomplete specification missing any required fields will be rejected with the error INVALID_ARGUMENT. */ updateTransferJobFieldMask?: string | null; } @@ -1025,7 +1025,7 @@ export namespace storagetransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. + * @param {string=} params.filter Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project``_``id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: ENABLED, DISABLED, and DELETED. * @param {integer=} params.pageSize The list page size. The max allowed value is 256. * @param {string=} params.pageToken The list page token. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. @@ -1096,7 +1096,7 @@ export namespace storagetransfer_v1 { /** * storagetransfer.transferJobs.patch - * @desc Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating a job's schedule is not allowed. Note: The job's `status` field can be modified using this RPC (for example, to set a job's status to `DELETED`, `DISABLED`, or `ENABLED`). + * @desc Updates a transfer job. Updating a job's transfer spec does not affect transfer operations that are running already. Updating a job's schedule is not allowed. **Note:** The job's status field can be modified using this RPC (for example, to set a job's status to DELETED, DISABLED, or ENABLED). * @example * * // BEFORE RUNNING: * // --------------- @@ -1254,7 +1254,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. + * Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "job_statuses":["status1","status2",...]}. Since `job_names` and `job_statuses` support multiple values, their values must be specified with array notation. `project``_``id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: ENABLED, DISABLED, and DELETED. */ filter?: string; /** @@ -1403,119 +1403,6 @@ export namespace storagetransfer_v1 { } } - /** - * storagetransfer.transferOperations.delete - * @desc This method is not supported and the server returns `UNIMPLEMENTED`. - * @example - * * // BEFORE RUNNING: - * // --------------- - * // 1. If not already done, enable the Storage Transfer API - * // and check the quota for your project at - * // https://console.developers.google.com/apis/api/storagetransfer - * // 2. This sample uses Application Default Credentials for authentication. - * // If not already done, install the gcloud CLI from - * // https://cloud.google.com/sdk and run - * // `gcloud beta auth application-default login`. - * // For more information, see - * // https://developers.google.com/identity/protocols/application-default-credentials - * // 3. Install the Node.js client library by running - * // `npm install googleapis --save` - * - * const {google} = require('googleapis'); - * var storagetransfer = google.storagetransfer('v1'); - * - * authorize(function(authClient) { - * var request = { - * // The name of the operation resource to be deleted. - * name: 'transferOperations/my-transfer-operation', // TODO: Update placeholder value. - * - * auth: authClient, - * }; - * - * storagetransfer.transferOperations.delete(request, function(err) { - * if (err) { - * console.error(err); - * return; - * } - * }); - * }); - * - * function authorize(callback) { - * google.auth.getClient({ - * scopes: ['https://www.googleapis.com/auth/cloud-platform'] - * }).then(client => { - * callback(client); - * }).catch(err => { - * console.error('authentication failed: ', err); - * }); - * } - * @alias storagetransfer.transferOperations.delete - * @memberOf! () - * - * @param {object} params Parameters for request - * @param {string} params.name The name of the operation resource to be deleted. - * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. - * @param {callback} callback The callback that handles the response. - * @return {object} Request object - */ - delete( - params?: Params$Resource$Transferoperations$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Transferoperations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Transferoperations$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Transferoperations$Delete - | BodyResponseCallback, - optionsOrCallback?: MethodOptions | BodyResponseCallback, - callback?: BodyResponseCallback - ): void | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Transferoperations$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Transferoperations$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://storagetransfer.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); - } - } - /** * storagetransfer.transferOperations.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. @@ -1700,7 +1587,7 @@ export namespace storagetransfer_v1 { * @memberOf! () * * @param {object} params Parameters for request - * @param {string=} params.filter Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "operation_names":["opid1","opid2",...], "transfer_statuses":["status1","status2",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `project_id` is required. `job_names`, `operation_names`, and `transfer_statuses` are optional. The valid values for `transfer_statuses` are case-insensitive: `IN_PROGRESS`, `PAUSED`, `SUCCESS`, `FAILED`, and `ABORTED`. + * @param {string=} params.filter Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "operation_names":["opid1","opid2",...], "transfer_statuses":["status1","status2",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `project``_``id` is required. `job_names`, `operation_names`, and `transfer_statuses` are optional. The valid values for `transfer_statuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED. * @param {string} params.name Required. The value `transferOperations`. * @param {integer=} params.pageSize The list page size. The max allowed value is 256. * @param {string=} params.pageToken The list page token. @@ -2019,18 +1906,6 @@ export namespace storagetransfer_v1 { */ name?: string; } - export interface Params$Resource$Transferoperations$Delete - extends StandardParameters { - /** - * Auth client or API Key for the request - */ - auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; - - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } export interface Params$Resource$Transferoperations$Get extends StandardParameters { /** @@ -2051,7 +1926,7 @@ export namespace storagetransfer_v1 { auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** - * Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "operation_names":["opid1","opid2",...], "transfer_statuses":["status1","status2",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `project_id` is required. `job_names`, `operation_names`, and `transfer_statuses` are optional. The valid values for `transfer_statuses` are case-insensitive: `IN_PROGRESS`, `PAUSED`, `SUCCESS`, `FAILED`, and `ABORTED`. + * Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", "job_names":["jobid1","jobid2",...], "operation_names":["opid1","opid2",...], "transfer_statuses":["status1","status2",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `project``_``id` is required. `job_names`, `operation_names`, and `transfer_statuses` are optional. The valid values for `transfer_statuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED. */ filter?: string; /** diff --git a/src/apis/streetviewpublish/v1.ts b/src/apis/streetviewpublish/v1.ts index 19799d6622..a2df4af8f5 100644 --- a/src/apis/streetviewpublish/v1.ts +++ b/src/apis/streetviewpublish/v1.ts @@ -627,7 +627,7 @@ export namespace streetviewpublish_v1 { /** * streetviewpublish.photo.startUpload - * @desc Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, the photo must meet the following requirements: * Photo Sphere XMP metadata must be included in the photo medadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry. + * @desc Creates an upload session to start uploading photo bytes. The method uses the upload URL of the returned UploadRef to upload the bytes for the Photo. In addition to the photo requirements shown in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, the photo must meet the following requirements: * Photo Sphere XMP metadata must be included in the photo metadata. See https://developers.google.com/streetview/spherical-metadata for the required fields. * The pixel size of the photo must meet the size requirements listed in https://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and the photo must be a full 360 horizontally. After the upload completes, the method uses UploadRef with CreatePhoto to create the Photo object entry. * @alias streetviewpublish.photo.startUpload * @memberOf! () * diff --git a/src/apis/tasks/v1.ts b/src/apis/tasks/v1.ts index 5871c0da54..b91f748ce3 100644 --- a/src/apis/tasks/v1.ts +++ b/src/apis/tasks/v1.ts @@ -376,7 +376,7 @@ export namespace tasks_v1 { /** * tasks.tasklists.insert - * @desc Creates a new task list and adds it to the authenticated user's task lists. + * @desc Creates a new task list and adds it to the authenticated user's task lists. Fails with HTTP code 403 or 429 after reaching the storage limit of 2,000 lists. * @alias tasks.tasklists.insert * @memberOf! () * @@ -968,7 +968,7 @@ export namespace tasks_v1 { /** * tasks.tasks.insert - * @desc Creates a new task on the specified task list. + * @desc Creates a new task on the specified task list. Fails with HTTP code 403 or 429 after reaching the storage limit of 100,000 tasks per account. * @alias tasks.tasks.insert * @memberOf! () * diff --git a/src/apis/testing/v1.ts b/src/apis/testing/v1.ts index 3cd4393424..e06278ed6f 100644 --- a/src/apis/testing/v1.ts +++ b/src/apis/testing/v1.ts @@ -1019,6 +1019,12 @@ export namespace testing_v1 { */ uri?: string | null; } + export interface Schema$SystraceSetup { + /** + * Systrace duration in seconds. Should be between 1 and 30 seconds. 0 disables systrace. + */ + durationSeconds?: number | null; + } /** * Additional details about the progress of the running test. */ @@ -1179,6 +1185,10 @@ export namespace testing_v1 { * The network traffic profile used for running the test. Available network profiles can be queried by using the NETWORK_CONFIGURATION environment type when calling TestEnvironmentDiscoveryService.GetTestEnvironmentCatalog. */ networkProfile?: string | null; + /** + * Systrace configuration for the run. If set a systrace will be taken, starting on test start and lasting for the configured duration. The systrace file thus obtained is put in the results bucket together with the other artifacts from the run. + */ + systrace?: Schema$SystraceSetup; } /** * A description of how to run the test. diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index 8974e03d40..7756fc7ca3 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -256,7 +256,7 @@ export namespace tpu_v1 { */ acceleratorType?: string | null; /** - * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. Required. + * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. */ cidrBlock?: string | null; /** diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index 38d6cfa891..62eb65c853 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -256,7 +256,7 @@ export namespace tpu_v1alpha1 { */ acceleratorType?: string | null; /** - * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. Required. + * The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. */ cidrBlock?: string | null; /** diff --git a/src/apis/translate/index.ts b/src/apis/translate/index.ts index 79d73c00dd..c8b16bcdac 100644 --- a/src/apis/translate/index.ts +++ b/src/apis/translate/index.ts @@ -15,10 +15,12 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {translate_v2} from './v2'; +import {translate_v3} from './v3'; import {translate_v3beta1} from './v3beta1'; export const VERSIONS = { v2: translate_v2.Translate, + v3: translate_v3.Translate, v3beta1: translate_v3beta1.Translate, }; @@ -26,17 +28,26 @@ export function translate(version: 'v2'): translate_v2.Translate; export function translate( options: translate_v2.Options ): translate_v2.Translate; +export function translate(version: 'v3'): translate_v3.Translate; +export function translate( + options: translate_v3.Options +): translate_v3.Translate; export function translate(version: 'v3beta1'): translate_v3beta1.Translate; export function translate( options: translate_v3beta1.Options ): translate_v3beta1.Translate; export function translate< - T = translate_v2.Translate | translate_v3beta1.Translate + T = + | translate_v2.Translate + | translate_v3.Translate + | translate_v3beta1.Translate >( this: GoogleConfigurable, versionOrOptions: | 'v2' | translate_v2.Options + | 'v3' + | translate_v3.Options | 'v3beta1' | translate_v3beta1.Options ) { diff --git a/src/apis/translate/v3.ts b/src/apis/translate/v3.ts new file mode 100644 index 0000000000..6c964db84b --- /dev/null +++ b/src/apis/translate/v3.ts @@ -0,0 +1,2228 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, +} from 'google-auth-library'; +import { + GoogleConfigurable, + createAPIRequest, + MethodOptions, + GlobalOptions, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {GaxiosPromise} from 'gaxios'; + +// tslint:disable: no-any +// tslint:disable: class-name +// tslint:disable: variable-name +// tslint:disable: jsdoc-format +// tslint:disable: no-namespace + +export namespace translate_v3 { + export interface Options extends GlobalOptions { + version: 'v3'; + } + + 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 Translation API + * + * Integrates text translation into your website or application. + * + * @example + * const {google} = require('googleapis'); + * const translate = google.translate('v3'); + * + * @namespace translate + * @type {Function} + * @version v3 + * @variation v3 + * @param {object=} options Options for Translate + */ + export class Translate { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * The batch translation request. + */ + export interface Schema$BatchTranslateTextRequest { + /** + * Optional. Glossaries to be applied for translation. It's keyed by target language code. + */ + glossaries?: {[key: string]: Schema$TranslateTextGlossaryConfig} | null; + /** + * Required. Input configurations. The total number of files matched should be <= 1000. The total content size should be <= 100M Unicode codepoints. The files must use UTF-8 encoding. + */ + inputConfigs?: Schema$InputConfig[]; + /** + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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. See https://cloud.google.com/translate/docs/advanced/labels for more information. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. The models to use for translation. Map's key is target language code. Map's value is model name. Value can be a built-in general model, or an AutoML Translation model. The value format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` If the map is empty or a specific model is not requested for a language pair, then default google model (nmt) is used. + */ + models?: {[key: string]: string} | null; + /** + * Required. Output configuration. If 2 input configs match to the same file (that is, same input path), we don't generate output for duplicate inputs. + */ + outputConfig?: Schema$OutputConfig; + /** + * Required. Source language code. + */ + sourceLanguageCode?: string | null; + /** + * Required. Specify up to 10 language codes here. + */ + targetLanguageCodes?: string[] | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * The response message for language detection. + */ + export interface Schema$DetectedLanguage { + /** + * The confidence of the detection result for this language. + */ + confidence?: number | null; + /** + * The BCP-47 language code of source content in the request, detected automatically. + */ + languageCode?: string | null; + } + /** + * The request message for language detection. + */ + export interface Schema$DetectLanguageRequest { + /** + * The content of the input stored as a string. + */ + content?: string | null; + /** + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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. See https://cloud.google.com/translate/docs/advanced/labels for more information. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html". + */ + mimeType?: string | null; + /** + * Optional. The language detection model to be used. Format: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/{model-id}` Only one language detection model is currently supported: `projects/{project-number-or-id}/locations/{location-id}/models/language-detection/default`. If not specified, the default model is used. + */ + model?: string | null; + } + /** + * The response message for language detection. + */ + export interface Schema$DetectLanguageResponse { + /** + * A list of detected languages sorted by detection confidence in descending order. The most probable language first. + */ + languages?: Schema$DetectedLanguage[]; + } + /** + * 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 {} + /** + * The Google Cloud Storage location for the output content. + */ + export interface Schema$GcsDestination { + /** + * Required. There must be no files under 'output_uri_prefix'. 'output_uri_prefix' must end with "/" and start with "gs://", otherwise an INVALID_ARGUMENT (400) error is returned. + */ + outputUriPrefix?: string | null; + } + /** + * The Google Cloud Storage location for the input content. + */ + export interface Schema$GcsSource { + /** + * Required. Source data URI. For example, `gs://my_bucket/my_object`. + */ + inputUri?: string | null; + } + /** + * Represents a glossary built from user provided data. + */ + export interface Schema$Glossary { + /** + * Output only. When the glossary creation was finished. + */ + endTime?: string | null; + /** + * Output only. The number of entries defined in the glossary. + */ + entryCount?: number | null; + /** + * Required. Provides examples to build the glossary from. Total glossary must not exceed 10M Unicode codepoints. + */ + inputConfig?: Schema$GlossaryInputConfig; + /** + * Used with equivalent term set glossaries. + */ + languageCodesSet?: Schema$LanguageCodesSet; + /** + * Used with unidirectional glossaries. + */ + languagePair?: Schema$LanguageCodePair; + /** + * Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`. + */ + name?: string | null; + /** + * Output only. When CreateGlossary was called. + */ + submitTime?: string | null; + } + /** + * Input configuration for glossaries. + */ + export interface Schema$GlossaryInputConfig { + /** + * Required. Google Cloud Storage location of glossary data. File format is determined based on the filename extension. API returns [google.rpc.Code.INVALID_ARGUMENT] for unsupported URI-s and file formats. Wildcards are not allowed. This must be a single file in one of the following formats: For unidirectional glossaries: - TSV/CSV (`.tsv`/`.csv`): 2 column file, tab- or comma-separated. The first column is source text. The second column is target text. The file must not contain headers. That is, the first row is data, not column names. - TMX (`.tmx`): TMX file with parallel data defining source/target term pairs. For equivalent term sets glossaries: - CSV (`.csv`): Multi-column CSV file defining equivalent glossary terms in multiple languages. The format is defined for Google Translation Toolkit and documented in [Use a glossary](https://support.google.com/translatortoolkit/answer/6306379?hl=en). + */ + gcsSource?: Schema$GcsSource; + } + /** + * Input configuration for BatchTranslateText request. + */ + export interface Schema$InputConfig { + /** + * Required. Google Cloud Storage location for the source input. This can be a single file (for example, `gs://translation-test/input.tsv`) or a wildcard (for example, `gs://translation-test/x). If a file extension is `.tsv`, it can contain either one or two columns. The first column (optional) is the id of the text request. If the first column is missing, we use the row number (0-based) from the input file as the ID in the output file. The second column is the actual text to be translated. We recommend each row be <= 10K Unicode codepoints, otherwise an error might be returned. Note that the input tsv must be RFC 4180 compliant. You could use https://github.com/Clever/csvlint to check potential formatting errors in your tsv file. csvlint --delimiter='\t' your_input_file.tsv The other supported file extensions are `.txt` or `.html`, which is treated as a single large chunk of text. + */ + gcsSource?: Schema$GcsSource; + /** + * Optional. Can be "text/plain" or "text/html". For `.tsv`, "text/html" is used if mime_type is missing. For `.html`, this field must be "text/html" or empty. For `.txt`, this field must be "text/plain" or empty. + */ + mimeType?: string | null; + } + /** + * Used with unidirectional glossaries. + */ + export interface Schema$LanguageCodePair { + /** + * Required. The BCP-47 language code of the input text, for example, "en-US". Expected to be an exact match for GlossaryTerm.language_code. + */ + sourceLanguageCode?: string | null; + /** + * Required. The BCP-47 language code for translation output, for example, "zh-CN". Expected to be an exact match for GlossaryTerm.language_code. + */ + targetLanguageCode?: string | null; + } + /** + * Used with equivalent term set glossaries. + */ + export interface Schema$LanguageCodesSet { + /** + * The BCP-47 language code(s) for terms defined in the glossary. All entries are unique. The list contains at least two entries. Expected to be an exact match for GlossaryTerm.language_code. + */ + languageCodes?: string[] | null; + } + /** + * Response message for ListGlossaries. + */ + export interface Schema$ListGlossariesResponse { + /** + * The list of glossaries for a project. + */ + glossaries?: Schema$Glossary[]; + /** + * A token to retrieve a page of results. Pass this value in the [ListGlossariesRequest.page_token] field in the subsequent call to `ListGlossaries` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * 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 | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * 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 | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. + */ + done?: boolean | null; + /** + * 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} | null; + /** + * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. + */ + name?: string | null; + /** + * The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Output configuration for BatchTranslateText request. + */ + export interface Schema$OutputConfig { + /** + * Google Cloud Storage destination for output content. For every single input file (for example, gs://a/b/c.[extension]), we generate at most 2 * n output files. (n is the # of target_language_codes in the BatchTranslateTextRequest). Output files (tsv) generated are compliant with RFC 4180 except that record delimiters are 'x/' instead of '\rx/'. We don't provide any way to change record delimiters. While the input files are being processed, we write/update an index file 'index.csv' under 'output_uri_prefix' (for example, gs://translation-test/index.csv) The index file is generated/updated as new files are being translated. The format is: input_file,target_language_code,translations_file,errors_file, glossary_translations_file,glossary_errors_file input_file is one file we matched using gcs_source.input_uri. target_language_code is provided in the request. translations_file contains the translations. (details provided below) errors_file contains the errors during processing of the file. (details below). Both translations_file and errors_file could be empty strings if we have no content to output. glossary_translations_file and glossary_errors_file are always empty strings if the input_file is tsv. They could also be empty if we have no content to output. Once a row is present in index.csv, the input/output matching never changes. Callers should also expect all the content in input_file are processed and ready to be consumed (that is, no partial output file is written). The format of translations_file (for target language code 'trg') is: gs://translation_test/a_b_c_'trg'_translations.[extension] If the input file extension is tsv, the output has the following columns: Column 1: ID of the request provided in the input, if it's not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: translation without applying a glossary. Empty string if there is an error. Column 4 (only present if a glossary is provided in the request): translation after applying the glossary. Empty string if there is an error applying the glossary. Could be same string as column 3 if there is no glossary applied. If input file extension is a txt or html, the translation is directly written to the output file. If glossary is requested, a separate glossary_translations_file has format of gs://translation_test/a_b_c_'trg'_glossary_translations.[extension] The format of errors file (for target language code 'trg') is: gs://translation_test/a_b_c_'trg'_errors.[extension] If the input file extension is tsv, errors_file contains the following: Column 1: ID of the request provided in the input, if it's not provided in the input, then the input row number is used (0-based). Column 2: source sentence. Column 3: Error detail for the translation. Could be empty. Column 4 (only present if a glossary is provided in the request): Error when applying the glossary. If the input file extension is txt or html, glossary_error_file will be generated that contains error details. glossary_error_file has format of gs://translation_test/a_b_c_'trg'_glossary_errors.[extension] + */ + gcsDestination?: Schema$GcsDestination; + } + /** + * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * 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}> | null; + /** + * 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 | null; + } + /** + * A single supported language response corresponds to information related to one supported language. + */ + export interface Schema$SupportedLanguage { + /** + * Human readable name of the language localized in the display language specified in the request. + */ + displayName?: string | null; + /** + * Supported language code, generally consisting of its ISO 639-1 identifier, for example, 'en', 'ja'. In certain cases, BCP-47 codes including language and region identifiers are returned (for example, 'zh-TW' and 'zh-CN') + */ + languageCode?: string | null; + /** + * Can be used as source language. + */ + supportSource?: boolean | null; + /** + * Can be used as target language. + */ + supportTarget?: boolean | null; + } + /** + * The response message for discovering supported languages. + */ + export interface Schema$SupportedLanguages { + /** + * A list of supported language responses. This list contains an entry for each language the Translation API supports. + */ + languages?: Schema$SupportedLanguage[]; + } + /** + * Configures which glossary should be used for a specific target language, and defines options for applying that glossary. + */ + export interface Schema$TranslateTextGlossaryConfig { + /** + * Required. The `glossary` to be applied for this translation. The format depends on glossary: - User provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}` + */ + glossary?: string | null; + /** + * Optional. Indicates match is case-insensitive. Default value is false if missing. + */ + ignoreCase?: boolean | null; + } + /** + * The request message for synchronous translation. + */ + export interface Schema$TranslateTextRequest { + /** + * Required. The content of the input in string format. We recommend the total content be less than 30k codepoints. Use BatchTranslateText for larger text. + */ + contents?: string[] | null; + /** + * Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned. + */ + glossaryConfig?: Schema$TranslateTextGlossaryConfig; + /** + * Optional. The labels with user-defined metadata for the request. Label keys and values can be no longer than 63 characters (Unicode codepoints), 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. See https://cloud.google.com/translate/docs/advanced/labels for more information. + */ + labels?: {[key: string]: string} | null; + /** + * Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html". + */ + mimeType?: string | null; + /** + * Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If missing, the system decides which google base model to use. + */ + model?: string | null; + /** + * Optional. The BCP-47 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. + */ + sourceLanguageCode?: string | null; + /** + * Required. The BCP-47 language code to use for translation of the input text, set to one of the language codes listed in Language Support. + */ + targetLanguageCode?: string | null; + } + export interface Schema$TranslateTextResponse { + /** + * Text translation responses if a glossary is provided in the request. This can be the same as `translations` if no terms apply. This field has the same length as `contents`. + */ + glossaryTranslations?: Schema$Translation[]; + /** + * Text translation responses with no glossary applied. This field has the same length as `contents`. + */ + translations?: Schema$Translation[]; + } + /** + * A single translation response. + */ + export interface Schema$Translation { + /** + * The BCP-47 language code of source text in the initial request, detected automatically, if no source language was passed within the initial request. If the source language was passed, auto-detection of the language does not occur and this field is empty. + */ + detectedLanguageCode?: string | null; + /** + * The `glossary_config` used for this translation. + */ + glossaryConfig?: Schema$TranslateTextGlossaryConfig; + /** + * Only present when `model` is present in the request. `model` here is normalized to have project number. For example: If the `model` requested in TranslationTextRequest is `projects/{project-id}/locations/{location-id}/models/general/nmt` then `model` here would be normalized to `projects/{project-number}/locations/{location-id}/models/general/nmt`. + */ + model?: string | null; + /** + * Text translated into the target language. + */ + translatedText?: string | null; + } + /** + * The request message for Operations.WaitOperation. + */ + export interface Schema$WaitOperationRequest { + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + + /** + * translate.projects.detectLanguage + * @desc Detects the language of text within a request. + * @alias translate.projects.detectLanguage + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. + * @param {().DetectLanguageRequest} params.requestBody Request 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 + */ + detectLanguage( + params?: Params$Resource$Projects$Detectlanguage, + options?: MethodOptions + ): GaxiosPromise; + detectLanguage( + params: Params$Resource$Projects$Detectlanguage, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detectLanguage( + params: Params$Resource$Projects$Detectlanguage, + callback: BodyResponseCallback + ): void; + detectLanguage( + callback: BodyResponseCallback + ): void; + detectLanguage( + paramsOrCallback?: + | Params$Resource$Projects$Detectlanguage + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Detectlanguage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Detectlanguage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}:detectLanguage').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.getSupportedLanguages + * @desc Returns a list of supported languages for translation. + * @alias translate.projects.getSupportedLanguages + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.displayLanguageCode Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response. + * @param {string=} params.model Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` Returns languages supported by the specified model. If missing, we get supported languages of Google general base (PBMT) model. + * @param {string} params.parent Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is 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 + */ + getSupportedLanguages( + params?: Params$Resource$Projects$Getsupportedlanguages, + options?: MethodOptions + ): GaxiosPromise; + getSupportedLanguages( + params: Params$Resource$Projects$Getsupportedlanguages, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSupportedLanguages( + params: Params$Resource$Projects$Getsupportedlanguages, + callback: BodyResponseCallback + ): void; + getSupportedLanguages( + callback: BodyResponseCallback + ): void; + getSupportedLanguages( + paramsOrCallback?: + | Params$Resource$Projects$Getsupportedlanguages + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getsupportedlanguages; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getsupportedlanguages; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/supportedLanguages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.translateText + * @desc Translates input text and returns translated text. + * @alias translate.projects.translateText + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned. + * @param {().TranslateTextRequest} params.requestBody Request 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 + */ + translateText( + params?: Params$Resource$Projects$Translatetext, + options?: MethodOptions + ): GaxiosPromise; + translateText( + params: Params$Resource$Projects$Translatetext, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + translateText( + params: Params$Resource$Projects$Translatetext, + callback: BodyResponseCallback + ): void; + translateText( + callback: BodyResponseCallback + ): void; + translateText( + paramsOrCallback?: + | Params$Resource$Projects$Translatetext + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Translatetext; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Translatetext; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}:translateText').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$Detectlanguage + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DetectLanguageRequest; + } + export interface Params$Resource$Projects$Getsupportedlanguages + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response. + */ + displayLanguageCode?: string; + /** + * Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` Returns languages supported by the specified model. If missing, we get supported languages of Google general base (PBMT) model. + */ + model?: string; + /** + * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned. + */ + parent?: string; + } + export interface Params$Resource$Projects$Translatetext + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TranslateTextRequest; + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + glossaries: Resource$Projects$Locations$Glossaries; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.glossaries = new Resource$Projects$Locations$Glossaries( + this.context + ); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + + /** + * translate.projects.locations.batchTranslateText + * @desc Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call. + * @alias translate.projects.locations.batchTranslateText + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned. + * @param {().BatchTranslateTextRequest} params.requestBody Request 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 + */ + batchTranslateText( + params?: Params$Resource$Projects$Locations$Batchtranslatetext, + options?: MethodOptions + ): GaxiosPromise; + batchTranslateText( + params: Params$Resource$Projects$Locations$Batchtranslatetext, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + batchTranslateText( + params: Params$Resource$Projects$Locations$Batchtranslatetext, + callback: BodyResponseCallback + ): void; + batchTranslateText(callback: BodyResponseCallback): void; + batchTranslateText( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Batchtranslatetext + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Batchtranslatetext; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Batchtranslatetext; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}:batchTranslateText').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.detectLanguage + * @desc Detects the language of text within a request. + * @alias translate.projects.locations.detectLanguage + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. + * @param {().DetectLanguageRequest} params.requestBody Request 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 + */ + detectLanguage( + params?: Params$Resource$Projects$Locations$Detectlanguage, + options?: MethodOptions + ): GaxiosPromise; + detectLanguage( + params: Params$Resource$Projects$Locations$Detectlanguage, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detectLanguage( + params: Params$Resource$Projects$Locations$Detectlanguage, + callback: BodyResponseCallback + ): void; + detectLanguage( + callback: BodyResponseCallback + ): void; + detectLanguage( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Detectlanguage + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Detectlanguage; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Detectlanguage; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}:detectLanguage').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.get + * @desc Gets information about a location. + * @alias translate.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://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.getSupportedLanguages + * @desc Returns a list of supported languages for translation. + * @alias translate.projects.locations.getSupportedLanguages + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.displayLanguageCode Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response. + * @param {string=} params.model Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` Returns languages supported by the specified model. If missing, we get supported languages of Google general base (PBMT) model. + * @param {string} params.parent Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is 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 + */ + getSupportedLanguages( + params?: Params$Resource$Projects$Locations$Getsupportedlanguages, + options?: MethodOptions + ): GaxiosPromise; + getSupportedLanguages( + params: Params$Resource$Projects$Locations$Getsupportedlanguages, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSupportedLanguages( + params: Params$Resource$Projects$Locations$Getsupportedlanguages, + callback: BodyResponseCallback + ): void; + getSupportedLanguages( + callback: BodyResponseCallback + ): void; + getSupportedLanguages( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getsupportedlanguages + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getsupportedlanguages; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getsupportedlanguages; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/supportedLanguages').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.list + * @desc Lists information about the supported locations for this service. + * @alias translate.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://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+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); + } + } + + /** + * translate.projects.locations.translateText + * @desc Translates input text and returns translated text. + * @alias translate.projects.locations.translateText + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned. + * @param {().TranslateTextRequest} params.requestBody Request 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 + */ + translateText( + params?: Params$Resource$Projects$Locations$Translatetext, + options?: MethodOptions + ): GaxiosPromise; + translateText( + params: Params$Resource$Projects$Locations$Translatetext, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + translateText( + params: Params$Resource$Projects$Locations$Translatetext, + callback: BodyResponseCallback + ): void; + translateText( + callback: BodyResponseCallback + ): void; + translateText( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Translatetext + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Translatetext; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Translatetext; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}:translateText').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$Batchtranslatetext + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}`. The `global` location is not supported for batch translation. Only AutoML Translation models or glossaries within the same region (have the same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BatchTranslateTextRequest; + } + export interface Params$Resource$Projects$Locations$Detectlanguage + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}/locations/{location-id}` or `projects/{project-number-or-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Only models within the same region (has same location-id) can be used. Otherwise an INVALID_ARGUMENT (400) error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DetectLanguageRequest; + } + 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$Getsupportedlanguages + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. The language to use to return localized, human readable names of supported languages. If missing, then display names are not returned in a response. + */ + displayLanguageCode?: string; + /** + * Optional. Get supported languages of this model. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, `projects/{project-number-or-id}/locations/{location-id}/models/general/base` Returns languages supported by the specified model. If missing, we get supported languages of Google general base (PBMT) model. + */ + model?: string; + /** + * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for AutoML models. Only models within the same region (have same location-id) can be used, otherwise an INVALID_ARGUMENT (400) error is returned. + */ + parent?: 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 interface Params$Resource$Projects$Locations$Translatetext + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. Project or location to make a call. Must refer to a caller's project. Format: `projects/{project-number-or-id}` or `projects/{project-number-or-id}/locations/{location-id}`. For global calls, use `projects/{project-number-or-id}/locations/global` or `projects/{project-number-or-id}`. Non-global location is required for requests using AutoML models or custom glossaries. Models and glossaries must be within the same region (have same location-id), otherwise an INVALID_ARGUMENT (400) error is returned. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TranslateTextRequest; + } + + export class Resource$Projects$Locations$Glossaries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * translate.projects.locations.glossaries.create + * @desc Creates a glossary and returns the long-running operation. Returns NOT_FOUND, if the project doesn't exist. + * @alias translate.projects.locations.glossaries.create + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.parent Required. The project name. + * @param {().Glossary} params.requestBody Request 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$Glossaries$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Glossaries$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Glossaries$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Glossaries$Create + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Glossaries$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Glossaries$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/glossaries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.glossaries.delete + * @desc Deletes a glossary, or cancels glossary construction if the glossary isn't created yet. Returns NOT_FOUND, if the glossary doesn't exist. + * @alias translate.projects.locations.glossaries.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the glossary 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$Glossaries$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Glossaries$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Glossaries$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Glossaries$Delete + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Glossaries$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Glossaries$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.glossaries.get + * @desc Gets a glossary. Returns NOT_FOUND, if the glossary doesn't exist. + * @alias translate.projects.locations.glossaries.get + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name Required. The name of the glossary 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$Glossaries$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Glossaries$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Glossaries$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Glossaries$Get + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Glossaries$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Glossaries$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.glossaries.list + * @desc Lists glossaries in a project. Returns NOT_FOUND, if the project doesn't exist. + * @alias translate.projects.locations.glossaries.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed. + * @param {integer=} params.pageSize Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default. + * @param {string=} params.pageToken Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing. + * @param {string} params.parent Required. The name of the project from which to list all of the glossaries. + * @param {object} [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$Glossaries$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Glossaries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Glossaries$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Glossaries$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Glossaries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Glossaries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/glossaries').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Glossaries$Create + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The project name. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Glossary; + } + export interface Params$Resource$Projects$Locations$Glossaries$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the glossary to delete. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Glossaries$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Required. The name of the glossary to retrieve. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Glossaries$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * Optional. Filter specifying constraints of a list operation. Filtering is not supported yet, and the parameter currently has no effect. If missing, no filtering is performed. + */ + filter?: string; + /** + * Optional. Requested page size. The server may return fewer glossaries than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of [ListGlossariesResponse.next_page_token] returned from the previous call to `ListGlossaries` method. The first page is returned if `page_token`is empty or missing. + */ + pageToken?: string; + /** + * Required. The name of the project from which to list all of the glossaries. + */ + parent?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * translate.projects.locations.operations.cancel + * @desc Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * @alias translate.projects.locations.operations.cancel + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be cancelled. + * @param {().CancelOperationRequest} params.requestBody Request body data + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.operations.delete + * @desc Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * @alias translate.projects.locations.operations.delete + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to be deleted. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback, + optionsOrCallback?: MethodOptions | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.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 translate.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://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.operations.list + * @desc Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. + * @alias translate.projects.locations.operations.list + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string=} params.filter The standard list filter. + * @param {string} params.name The name of the operation's parent resource. + * @param {integer=} params.pageSize The standard list page size. + * @param {string=} params.pageToken The standard list page token. + * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. + * @param {callback} callback The callback that handles the response. + * @return {object} Request object + */ + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest(parameters, callback); + } else { + return createAPIRequest(parameters); + } + } + + /** + * translate.projects.locations.operations.wait + * @desc Waits for the specified long-running operation until it is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * @alias translate.projects.locations.operations.wait + * @memberOf! () + * + * @param {object} params Parameters for request + * @param {string} params.name The name of the operation resource to wait on. + * @param {().WaitOperationRequest} params.requestBody Request 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 + */ + wait( + params?: Params$Resource$Projects$Locations$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait(callback: BodyResponseCallback): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Wait + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | BodyResponseCallback, + callback?: BodyResponseCallback + ): void | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://translation.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}:wait').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$Operations$Cancel + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Wait + extends StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; + + /** + * The name of the operation resource to wait on. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$WaitOperationRequest; + } +} diff --git a/src/apis/videointelligence/v1.ts b/src/apis/videointelligence/v1.ts index 7a5b7d65bf..6a090315aa 100644 --- a/src/apis/videointelligence/v1.ts +++ b/src/apis/videointelligence/v1.ts @@ -1339,6 +1339,23 @@ export namespace videointelligence_v1 { */ value?: string | null; } + /** + * A generic detected landmark represented by name in string format and a 2D location. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark { + /** + * The confidence score of the detected landmark. Range [0, 1]. + */ + confidence?: number | null; + /** + * The name of this landmark, i.e. left_hand, right_shoulder. + */ + name?: string | null; + /** + * The 2D point of the detected landmark using the normalized image coordindate system. The normalized coordinates have the range from 0 to 1. + */ + point?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex; + } /** * Detected entity from video analysis. */ @@ -1378,6 +1395,19 @@ export namespace videointelligence_v1 { */ timeOffset?: string | null; } + /** + * Face detection annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation { + /** + * The thumbnail of a person's face. + */ + thumbnail?: string | null; + /** + * The face tracks with attributes. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Label annotation. */ @@ -1523,6 +1553,15 @@ export namespace videointelligence_v1 { */ timeOffset?: string | null; } + /** + * Person detection annotation per video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { + /** + * The trackes that a person is detected. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * The recognized celebrity with confidence score. */ @@ -1655,6 +1694,10 @@ export namespace videointelligence_v1 { * Optional. The attributes of the object in the bounding box. */ attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The detected landmarks. + */ + landmarks?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark[]; /** * Normalized Bounding box in a frame, where the object is located. */ @@ -1730,6 +1773,10 @@ export namespace videointelligence_v1 { * Explicit content annotation. */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; + /** + * Face detection annotations. + */ + faceDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation[]; /** * Label annotations on frame level. There is exactly one element for each unique label. */ @@ -1746,6 +1793,10 @@ export namespace videointelligence_v1 { * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; + /** + * Person detection annotations. + */ + personDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation[]; /** * Video segment on which the annotation is run. */ diff --git a/src/apis/videointelligence/v1beta2.ts b/src/apis/videointelligence/v1beta2.ts index 2d9a102c9a..7b6f63fdef 100644 --- a/src/apis/videointelligence/v1beta2.ts +++ b/src/apis/videointelligence/v1beta2.ts @@ -1512,6 +1512,23 @@ export namespace videointelligence_v1beta2 { */ value?: string | null; } + /** + * A generic detected landmark represented by name in string format and a 2D location. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark { + /** + * The confidence score of the detected landmark. Range [0, 1]. + */ + confidence?: number | null; + /** + * The name of this landmark, i.e. left_hand, right_shoulder. + */ + name?: string | null; + /** + * The 2D point of the detected landmark using the normalized image coordindate system. The normalized coordinates have the range from 0 to 1. + */ + point?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex; + } /** * Detected entity from video analysis. */ @@ -1551,6 +1568,19 @@ export namespace videointelligence_v1beta2 { */ timeOffset?: string | null; } + /** + * Face detection annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation { + /** + * The thumbnail of a person's face. + */ + thumbnail?: string | null; + /** + * The face tracks with attributes. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Label annotation. */ @@ -1696,6 +1726,15 @@ export namespace videointelligence_v1beta2 { */ timeOffset?: string | null; } + /** + * Person detection annotation per video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { + /** + * The trackes that a person is detected. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * The recognized celebrity with confidence score. */ @@ -1828,6 +1867,10 @@ export namespace videointelligence_v1beta2 { * Optional. The attributes of the object in the bounding box. */ attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The detected landmarks. + */ + landmarks?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark[]; /** * Normalized Bounding box in a frame, where the object is located. */ @@ -1903,6 +1946,10 @@ export namespace videointelligence_v1beta2 { * Explicit content annotation. */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; + /** + * Face detection annotations. + */ + faceDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation[]; /** * Label annotations on frame level. There is exactly one element for each unique label. */ @@ -1919,6 +1966,10 @@ export namespace videointelligence_v1beta2 { * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; + /** + * Person detection annotations. + */ + personDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation[]; /** * Video segment on which the annotation is run. */ diff --git a/src/apis/videointelligence/v1p1beta1.ts b/src/apis/videointelligence/v1p1beta1.ts index 747d8ce071..b9dbbc6905 100644 --- a/src/apis/videointelligence/v1p1beta1.ts +++ b/src/apis/videointelligence/v1p1beta1.ts @@ -1512,6 +1512,23 @@ export namespace videointelligence_v1p1beta1 { */ value?: string | null; } + /** + * A generic detected landmark represented by name in string format and a 2D location. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark { + /** + * The confidence score of the detected landmark. Range [0, 1]. + */ + confidence?: number | null; + /** + * The name of this landmark, i.e. left_hand, right_shoulder. + */ + name?: string | null; + /** + * The 2D point of the detected landmark using the normalized image coordindate system. The normalized coordinates have the range from 0 to 1. + */ + point?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex; + } /** * Detected entity from video analysis. */ @@ -1551,6 +1568,19 @@ export namespace videointelligence_v1p1beta1 { */ timeOffset?: string | null; } + /** + * Face detection annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation { + /** + * The thumbnail of a person's face. + */ + thumbnail?: string | null; + /** + * The face tracks with attributes. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Label annotation. */ @@ -1696,6 +1726,15 @@ export namespace videointelligence_v1p1beta1 { */ timeOffset?: string | null; } + /** + * Person detection annotation per video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { + /** + * The trackes that a person is detected. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * The recognized celebrity with confidence score. */ @@ -1828,6 +1867,10 @@ export namespace videointelligence_v1p1beta1 { * Optional. The attributes of the object in the bounding box. */ attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The detected landmarks. + */ + landmarks?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark[]; /** * Normalized Bounding box in a frame, where the object is located. */ @@ -1903,6 +1946,10 @@ export namespace videointelligence_v1p1beta1 { * Explicit content annotation. */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; + /** + * Face detection annotations. + */ + faceDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation[]; /** * Label annotations on frame level. There is exactly one element for each unique label. */ @@ -1919,6 +1966,10 @@ export namespace videointelligence_v1p1beta1 { * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; + /** + * Person detection annotations. + */ + personDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation[]; /** * Video segment on which the annotation is run. */ diff --git a/src/apis/videointelligence/v1p2beta1.ts b/src/apis/videointelligence/v1p2beta1.ts index d637dbb376..a86f0dcc8d 100644 --- a/src/apis/videointelligence/v1p2beta1.ts +++ b/src/apis/videointelligence/v1p2beta1.ts @@ -1512,6 +1512,23 @@ export namespace videointelligence_v1p2beta1 { */ value?: string | null; } + /** + * A generic detected landmark represented by name in string format and a 2D location. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark { + /** + * The confidence score of the detected landmark. Range [0, 1]. + */ + confidence?: number | null; + /** + * The name of this landmark, i.e. left_hand, right_shoulder. + */ + name?: string | null; + /** + * The 2D point of the detected landmark using the normalized image coordindate system. The normalized coordinates have the range from 0 to 1. + */ + point?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex; + } /** * Detected entity from video analysis. */ @@ -1551,6 +1568,19 @@ export namespace videointelligence_v1p2beta1 { */ timeOffset?: string | null; } + /** + * Face detection annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation { + /** + * The thumbnail of a person's face. + */ + thumbnail?: string | null; + /** + * The face tracks with attributes. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * Label annotation. */ @@ -1696,6 +1726,15 @@ export namespace videointelligence_v1p2beta1 { */ timeOffset?: string | null; } + /** + * Person detection annotation per video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { + /** + * The trackes that a person is detected. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } /** * The recognized celebrity with confidence score. */ @@ -1828,6 +1867,10 @@ export namespace videointelligence_v1p2beta1 { * Optional. The attributes of the object in the bounding box. */ attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The detected landmarks. + */ + landmarks?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark[]; /** * Normalized Bounding box in a frame, where the object is located. */ @@ -1903,6 +1946,10 @@ export namespace videointelligence_v1p2beta1 { * Explicit content annotation. */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; + /** + * Face detection annotations. + */ + faceDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation[]; /** * Label annotations on frame level. There is exactly one element for each unique label. */ @@ -1919,6 +1966,10 @@ export namespace videointelligence_v1p2beta1 { * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; + /** + * Person detection annotations. + */ + personDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation[]; /** * Video segment on which the annotation is run. */ diff --git a/src/apis/videointelligence/v1p3beta1.ts b/src/apis/videointelligence/v1p3beta1.ts index fc13c9dc6a..9340547dd3 100644 --- a/src/apis/videointelligence/v1p3beta1.ts +++ b/src/apis/videointelligence/v1p3beta1.ts @@ -1364,6 +1364,23 @@ export namespace videointelligence_v1p3beta1 { */ value?: string | null; } + /** + * A generic detected landmark represented by name in string format and a 2D location. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark { + /** + * The confidence score of the detected landmark. Range [0, 1]. + */ + confidence?: number | null; + /** + * The name of this landmark, i.e. left_hand, right_shoulder. + */ + name?: string | null; + /** + * The 2D point of the detected landmark using the normalized image coordindate system. The normalized coordinates have the range from 0 to 1. + */ + point?: Schema$GoogleCloudVideointelligenceV1p3beta1_NormalizedVertex; + } /** * Detected entity from video analysis. */ @@ -1412,6 +1429,36 @@ export namespace videointelligence_v1p3beta1 { */ timeOffset?: string | null; } + /** + * Face detection annotation. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation { + /** + * The thumbnail of a person's face. + */ + thumbnail?: string | null; + /** + * The face tracks with attributes. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } + /** + * Config for FACE_DETECTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionConfig { + /** + * Whether to enable face attributes detection, such as glasses, dark_glasses, mouth_open etc. Ignored if 'include_bounding_boxes' is false. + */ + includeAttributes?: boolean | null; + /** + * Whether bounding boxes be included in the face annotation output. + */ + includeBoundingBoxes?: boolean | null; + /** + * Model to use for face detection. Supported values: "builtin/stable" (the default if unset) and "builtin/latest". + */ + model?: string | null; + } /** * Label annotation. */ @@ -1591,6 +1638,32 @@ export namespace videointelligence_v1p3beta1 { */ timeOffset?: string | null; } + /** + * Person detection annotation per video. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation { + /** + * The trackes that a person is detected. + */ + tracks?: Schema$GoogleCloudVideointelligenceV1p3beta1_Track[]; + } + /** + * Config for PERSON_DETECTION. + */ + export interface Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionConfig { + /** + * Whether to enable person attributes detection, such as cloth color (black, blue, etc), type (coat, dress, etc), pattern (plain, floral, etc), hair color (black, blonde, etc), hair length (long, short, bald), etc. Ignored if 'include_bounding_boxes' is false. + */ + includeAttributes?: boolean | null; + /** + * Whether bounding boxes be included in the person detection annotation output. + */ + includeBoundingBoxes?: boolean | null; + /** + * Whether to enable pose landmarks detection. Ignored if 'include_bounding_boxes' is false. + */ + includePoseLandmarks?: boolean | null; + } /** * The recognized celebrity with confidence score. */ @@ -1795,6 +1868,10 @@ export namespace videointelligence_v1p3beta1 { * Optional. The attributes of the object in the bounding box. */ attributes?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedAttribute[]; + /** + * Optional. The detected landmarks. + */ + landmarks?: Schema$GoogleCloudVideointelligenceV1p3beta1_DetectedLandmark[]; /** * Normalized Bounding box in a frame, where the object is located. */ @@ -1870,6 +1947,10 @@ export namespace videointelligence_v1p3beta1 { * Explicit content annotation. */ explicitAnnotation?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentAnnotation; + /** + * Face detection annotations. + */ + faceDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionAnnotation[]; /** * Label annotations on frame level. There is exactly one element for each unique label. */ @@ -1886,6 +1967,10 @@ export namespace videointelligence_v1p3beta1 { * Annotations for list of objects detected and tracked in video. */ objectAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingAnnotation[]; + /** + * Person detection annotations. + */ + personDetectionAnnotations?: Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionAnnotation[]; /** * Video segment on which the annotation is run. */ @@ -1927,6 +2012,10 @@ export namespace videointelligence_v1p3beta1 { * Config for EXPLICIT_CONTENT_DETECTION. */ explicitContentDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p3beta1_ExplicitContentDetectionConfig; + /** + * Config for FACE_DETECTION. + */ + faceDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p3beta1_FaceDetectionConfig; /** * Config for LABEL_DETECTION. */ @@ -1935,6 +2024,10 @@ export namespace videointelligence_v1p3beta1 { * Config for OBJECT_TRACKING. */ objectTrackingConfig?: Schema$GoogleCloudVideointelligenceV1p3beta1_ObjectTrackingConfig; + /** + * Config for PERSON_DETECTION. + */ + personDetectionConfig?: Schema$GoogleCloudVideointelligenceV1p3beta1_PersonDetectionConfig; /** * Video segments to annotate. The segments may overlap and are not required to be contiguous or span the whole video. If unspecified, each video is treated as a single segment. */ diff --git a/src/apis/websecurityscanner/v1.ts b/src/apis/websecurityscanner/v1.ts index 92a2a47f9c..a1a8bdc047 100644 --- a/src/apis/websecurityscanner/v1.ts +++ b/src/apis/websecurityscanner/v1.ts @@ -218,6 +218,10 @@ export namespace websecurityscanner_v1 { * Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ reproductionUrl?: string | null; + /** + * Output only. The severity level of the reported vulnerability. + */ + severity?: string | null; /** * Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ diff --git a/src/apis/websecurityscanner/v1beta.ts b/src/apis/websecurityscanner/v1beta.ts index 7246406191..6625574b17 100644 --- a/src/apis/websecurityscanner/v1beta.ts +++ b/src/apis/websecurityscanner/v1beta.ts @@ -218,6 +218,10 @@ export namespace websecurityscanner_v1beta { * The URL containing human-readable payload that user can leverage to reproduce the vulnerability. */ reproductionUrl?: string | null; + /** + * The severity level of the reported vulnerability. + */ + severity?: string | null; /** * The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. */ diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 8599081bdd..0dce77392f 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -2036,6 +2036,9 @@ export namespace youtube_v3 { * If both this and enable_low_latency are set, they must match. LATENCY_NORMAL should match enable_low_latency=false LATENCY_LOW should match enable_low_latency=true LATENCY_ULTRA_LOW should have enable_low_latency omitted. */ latencyPreference?: string | null; + /** + * The mesh for projecting the video if projection is mesh. The mesh value must be a UTF-8 string containing the base-64 encoding of 3D mesh data that follows the Spherical Video V2 RFC specification for an mshp box, excluding the box size and type but including the following four reserved zero bytes for the version and flags. + */ mesh?: string | null; /** * The monitorStream object contains information about the monitor stream, which the broadcaster can use to review the event content before the broadcast stream is shown publicly. @@ -2723,37 +2726,49 @@ export namespace youtube_v3 { } export interface Schema$MembershipsDetails { /** - * All levels that the user has access to. This includes the currently active level and all other levels that are included because of a higher purchase. + * Ids of all levels that the user has access to. This includes the currently active level and all other levels that are included because of a higher purchase. */ accessibleLevels?: string[] | null; /** - * The highest level that the user has access to at the moment. + * Id of the highest level that the user has access to at the moment. */ highestAccessibleLevel?: string | null; /** - * Display name for the highest level that the user has access to at the moment. + * Display name of the highest level that the user has access to at the moment. */ highestAccessibleLevelDisplayName?: string | null; + /** + * Data about memberships duration without taking into consideration pricing levels. + */ + membershipsDuration?: Schema$MembershipsDuration; + /** + * Data about memberships duration on particular pricing levels. + */ + membershipsDurationAtLevels?: Schema$MembershipsDurationAtLevel[]; + } + export interface Schema$MembershipsDuration { /** * The date and time when the user became a continuous member across all levels. */ memberSince?: string | null; /** - * The date and time when the user started to continuously have access to the currently highest level. + * The cumulative time the user has been a member across all levels in complete months (the time is rounded down to the nearest integer). */ - memberSinceCurrentLevel?: string | null; + memberTotalDurationMonths?: number | null; + } + export interface Schema$MembershipsDurationAtLevel { /** - * The cumulative time the user has been a member across all levels in complete months (the time is rounded down to the nearest integer). + * Pricing level id. */ - memberTotalDuration?: number | null; + level?: string | null; /** - * The cumulative time the user has had access to the currently highest level in complete months (the time is rounded down to the nearest integer). + * The date and time when the user became a continuous member for the given level. */ - memberTotalDurationCurrentLevel?: number | null; + memberSince?: string | null; /** - * The highest level that the user has access to at the moment. DEPRECATED - highest_accessible_level should be used instead. This will be removed after we make sure there are no 3rd parties relying on it. + * The cumulative time the user has been a member for the given level in complete months (the time is rounded down to the nearest integer). */ - purchasedLevel?: string | null; + memberTotalDurationMonths?: number | null; } /** * A membershipsLevel resource represents an offer made by YouTube creators for their fans. Users can become members of the channel by joining one of the available levels. They will provide recurring monetary support and receives special benefits. @@ -4395,9 +4410,6 @@ export namespace youtube_v3 { * This value explains why YouTube rejected an uploaded video. This property is only present if the uploadStatus property indicates that the upload was rejected. */ rejectionReason?: string | null; - /** - * Allows clients to set the Crosswalk self_declared state for a Video. This maps to VAPI.Video.creator_flags.is_crosswalk_self_declared() and VAPI.Video.creator_flags.is_not_crosswalk_self_declared(). - */ selfDeclaredMadeForKids?: boolean | null; /** * The status of the uploaded video. diff --git a/src/index.ts b/src/index.ts index 3c457e2aa2..76c25579e3 100644 --- a/src/index.ts +++ b/src/index.ts @@ -20,6 +20,7 @@ export {google, GoogleApis}; export {abusiveexperiencereport_v1} from './apis/abusiveexperiencereport/v1'; export {acceleratedmobilepageurl_v1} from './apis/acceleratedmobilepageurl/v1'; +export {accessapproval_v1} from './apis/accessapproval/v1'; export {accessapproval_v1beta1} from './apis/accessapproval/v1beta1'; export {accesscontextmanager_v1} from './apis/accesscontextmanager/v1'; export {accesscontextmanager_v1beta} from './apis/accesscontextmanager/v1beta'; @@ -31,10 +32,10 @@ export {adexperiencereport_v1} from './apis/adexperiencereport/v1'; export {admin_datatransfer_v1} from './apis/admin/datatransfer_v1'; export {admin_directory_v1} from './apis/admin/directory_v1'; export {admin_reports_v1} from './apis/admin/reports_v1'; +export {admob_v1} from './apis/admob/v1'; export {adsense_v1_4} from './apis/adsense/v1.4'; export {adsensehost_v4_1} from './apis/adsensehost/v4.1'; export {alertcenter_v1beta1} from './apis/alertcenter/v1beta1'; -export {analytics_v2_4} from './apis/analytics/v2.4'; export {analytics_v3} from './apis/analytics/v3'; export {analyticsreporting_v4} from './apis/analyticsreporting/v4'; export {androiddeviceprovisioning_v1} from './apis/androiddeviceprovisioning/v1'; @@ -71,6 +72,7 @@ export {cloudasset_v1beta1} from './apis/cloudasset/v1beta1'; export {cloudbilling_v1} from './apis/cloudbilling/v1'; export {cloudbuild_v1} from './apis/cloudbuild/v1'; export {cloudbuild_v1alpha1} from './apis/cloudbuild/v1alpha1'; +export {cloudbuild_v1alpha2} from './apis/cloudbuild/v1alpha2'; export {clouddebugger_v2} from './apis/clouddebugger/v2'; export {clouderrorreporting_v1beta1} from './apis/clouderrorreporting/v1beta1'; export {cloudfunctions_v1} from './apis/cloudfunctions/v1'; @@ -96,6 +98,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 {cloudtrace_v2beta1} from './apis/cloudtrace/v2beta1'; export {commentanalyzer_v1alpha1} from './apis/commentanalyzer/v1alpha1'; export {composer_v1} from './apis/composer/v1'; export {composer_v1beta1} from './apis/composer/v1beta1'; @@ -151,7 +154,6 @@ export {firestore_v1beta1} from './apis/firestore/v1beta1'; export {firestore_v1beta2} from './apis/firestore/v1beta2'; export {fitness_v1} from './apis/fitness/v1'; export {games_v1} from './apis/games/v1'; -export {gamesConfiguration_v1configuration} from './apis/gamesConfiguration/v1configuration'; export {gamesManagement_v1management} from './apis/gamesManagement/v1management'; export {genomics_v1} from './apis/genomics/v1'; export {genomics_v1alpha2} from './apis/genomics/v1alpha2'; @@ -185,6 +187,7 @@ export {monitoring_v1} from './apis/monitoring/v1'; export {monitoring_v3} from './apis/monitoring/v3'; export {oauth2_v1} from './apis/oauth2/v1'; export {oauth2_v2} from './apis/oauth2/v2'; +export {osconfig_v1beta} from './apis/osconfig/v1beta'; export {oslogin_v1} from './apis/oslogin/v1'; export {oslogin_v1alpha} from './apis/oslogin/v1alpha'; export {oslogin_v1beta} from './apis/oslogin/v1beta'; @@ -195,7 +198,6 @@ export {pagespeedonline_v5} from './apis/pagespeedonline/v5'; export {people_v1} from './apis/people/v1'; export {playcustomapp_v1} from './apis/playcustomapp/v1'; export {plus_v1} from './apis/plus/v1'; -export {plusDomains_v1} from './apis/plusDomains/v1'; export {policytroubleshooter_v1} from './apis/policytroubleshooter/v1'; export {policytroubleshooter_v1beta} from './apis/policytroubleshooter/v1beta'; export {poly_v1} from './apis/poly/v1'; @@ -210,7 +212,6 @@ export {redis_v1beta1} from './apis/redis/v1beta1'; export {remotebuildexecution_v1} from './apis/remotebuildexecution/v1'; export {remotebuildexecution_v1alpha} from './apis/remotebuildexecution/v1alpha'; export {remotebuildexecution_v2} from './apis/remotebuildexecution/v2'; -export {replicapool_v1beta1} from './apis/replicapool/v1beta1'; export {reseller_v1} from './apis/reseller/v1'; export {run_v1} from './apis/run/v1'; export {run_v1alpha1} from './apis/run/v1alpha1'; @@ -220,14 +221,13 @@ export {runtimeconfig_v1beta1} from './apis/runtimeconfig/v1beta1'; export {safebrowsing_v4} from './apis/safebrowsing/v4'; export {sasportal_v1alpha1} from './apis/sasportal/v1alpha1'; export {script_v1} from './apis/script/v1'; +export {searchconsole_v1} from './apis/searchconsole/v1'; +export {secretmanager_v1} from './apis/secretmanager/v1'; export {secretmanager_v1beta1} from './apis/secretmanager/v1beta1'; export {securitycenter_v1} from './apis/securitycenter/v1'; export {securitycenter_v1beta1} from './apis/securitycenter/v1beta1'; export {securitycenter_v1p1alpha1} from './apis/securitycenter/v1p1alpha1'; export {securitycenter_v1p1beta1} from './apis/securitycenter/v1p1beta1'; -export {servicebroker_v1} from './apis/servicebroker/v1'; -export {servicebroker_v1alpha1} from './apis/servicebroker/v1alpha1'; -export {servicebroker_v1beta1} from './apis/servicebroker/v1beta1'; export {serviceconsumermanagement_v1} from './apis/serviceconsumermanagement/v1'; export {servicecontrol_v1} from './apis/servicecontrol/v1'; export {servicemanagement_v1} from './apis/servicemanagement/v1'; @@ -259,6 +259,7 @@ export {toolresults_v1beta3} from './apis/toolresults/v1beta3'; export {tpu_v1} from './apis/tpu/v1'; export {tpu_v1alpha1} from './apis/tpu/v1alpha1'; export {translate_v2} from './apis/translate/v2'; +export {translate_v3} from './apis/translate/v3'; export {translate_v3beta1} from './apis/translate/v3beta1'; export {vault_v1} from './apis/vault/v1'; export {verifiedaccess_v1} from './apis/verifiedaccess/v1';